Magikarp, a very useless & very bad project named after a very useless & very bad Pokemon.
Prerequisites:
- Node 15+
- npm
- PostgreSQL
Setup:
- Ensure you have all above prerequisites installed
- Clone the repository from this GitHub repository
- Install all npm packages with
npm install - Configure PostgreSQL within the
.envfile- Database name must be included within the URI
- Run
prisma migrate dev --name init - Run
npm run devto start the development server - View the page at
localhost:3000
| Name | Usage | Notes |
|---|---|---|
| Typescript | Programming Language | |
| React | Frontend UI | |
| Next.js | Server Side Rendering/Routing | |
| NextAuth.js | Authentication for Next.js | Extremely overkill — bundled with 45 auth providers, we only use Google |
| PostgreSQL | Database | Prisma also supports MySQL & SQLite — We enforce PostgreSQL |
| Prisma | Object Relational Mapping | |
| zustand | State Management | |
| Sass | Stylesheets | |
| Tailwind CSS | CSS Utility Classes | |
| Day.js | Date/Time JS Utilities | |
| joi | Schema Validation | |
| Prettier | Code Formatter | |
| ESLint | Static Code Analysis | |
| Autoprefixer | Applies vendor prefixes to CSS |