Show Off - Showcase your setup!
How often do you get asked about the gadgets or software that you use? If the answer is quite often, you should be trying show off out. Curate the list of gadgets and software and share it with your fans and followers.
View Demo · Report Bug · Request Feature
Features
✨
- Multiple Collections
- Built for developers, designers, and content creators
- Share & Embed
- Private collections
- Like and Comments
- Recommendation Meter
- Affiliate Links
Detailed blog post: https://sreyaj.dev/show-off-showcase-your-setup-planetscale-hashnode-hackathon
Running Locally
💻
#1. Clone the repo
git clone https://github.com/adisreyaj/show-off.git
#2. Initialize the submodule (zigzag)
git submodule update --init
#3. Install the dependencies
npm install
#4. Install Peer deps for zigzag
npm i @floating-ui/dom
#5. Setup the environment variables
Set up all the required environment variables required for the back-end:
DATABASE_URL=mysql://localhost:3309/show-off
NODE_ENV=development
FRONT_END_CALLBACK_URL=http://localhost:4200/auth/callback
# JWT sign secret
JWT_SECRET=very_very_strong_secret_key
JWT_EXPIRY="3d"
COOKIE_SECRET=very_very_strong_secret_session_key
# Google OAuth Details
GOOGLE_CLIENT_ID=xxxxx.googleusercontent.com
GOOGLE_CLIENT_SECRET=xxxxxxx
GOOGLE_CALLBACK_URI=http://localhost:3333/api/auth/google/callback
# Github OAuth Details
GITHUB_CLIENT_ID=Iv1.xxxxxxxxxx
GITHUB_CLIENT_SECRET=xxxxxx
GITHUB_CALLBACK_URI=http://localhost:3333/api/auth/github/callback
#6. Set up the Database
Run the command to populate the DB with tables:
npm run prisma:push
#7. Start up the UI and Back-end
For UI:
npm start show-off
For Back-end
npm start api
UI: http://localhost:4200 & GQL: http://localhost:3333
Links and References
🔗
| Title | Link | Description |
|---|---|---|
| Angular | https://angular.io/ | Front-end framework |
| NestJs | https://docs.nestjs.com/ | Back-end framework based on NodeJs |
| PlanetScale | https://www.planetscale.com/ | MySQL Compatible DB |
| Prisma | https://www.prisma.io/ | Node.js and TypeScript ORM |
| Tailwind CSS | https://tailwindcss.com/ | Utility first CSS framework |
| Nx | https://nx.dev/#getting-started | Build system with monorepo support |
| PM2 | https://app.pm2.io/ | Advanced, production process manager for Node.JS |
Roadmap
See the open issues for a list of proposed features (and known issues).
License
Distributed under the Apache 2.0 License. See LICENSE for more information.
Show your support
Please
Made as part of PlanetScale x Hashnode hackathon.
2 Jul 5, 2022
66.6k Jan 4, 2023
6 Dec 15, 2022
2 Jul 2, 2022
3 Oct 30, 2022
3 May 22, 2022
3 Oct 29, 2022
29 Nov 19, 2022
11 Dec 17, 2022
9 Nov 1, 2021