https://github.com/selimdev00/just-in-case
https://github.com/selimdev00/just-in-case
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/selimdev00/just-in-case
- Owner: selimdev00
- Created: 2025-01-16T16:09:50.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-01-17T12:41:41.000Z (6 months ago)
- Last Synced: 2025-02-09T05:47:17.073Z (5 months ago)
- Language: TypeScript
- Size: 759 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Just in case
Admin panel with backend
- 💪🏻 Built with Node.js, Express.js, Nuxt.js, TailwindCSS, PrimeVue and NuxtAuth
- 🚀 Deployed with Docker
- 📦 Managed with Docker Compose
- 🔒 Secured with NuxtAuth
- 🧪 Test with Jest and Playwright for E2E testing
## Tech
- Node.js
- Express.js
- Nuxt.js
- TailwindCSS
- PrimeVue
- NuxtAuth
## Client
Run client with `npm run dev` (http://localhost:3000)
## Database & server
Run migrations with `npx sequelize-cli db:migrate`
Run seeders with `npx sequelize-cli db:seed:all`
Run server with `npm run dev` (http://localhost:3001)
Run tests with `npm run test`
## Tests
Client tests are written with playwright, server tests are written with jest
Client tests are valid if seeders are included in current database
## Run with Docker
Run with docker (needs docker-compose): docker compose up -d --build
If database does not exist yet backend run:
- Go to backend `cd backend`
- Run `npm install`
- Run `npm run migrate`
- Run `npm run seed:all`
- client -> http://localhost (nginx)
- backend -> http://localhost:3001 or http://localhost/api (nginx)
## Running locally
### Client
- Go to client `cd client`
- Copy `.env.example` to `.env`
- Run `npm install`
- Run`npm run dev` (http://localhost:3000)
### Backend
- Go to backend `cd backend`
- Copy `.env.example` to `.env`
- Run `npm install`
- Run `npm run migrate`
- Run `npm run seed:all`
- Run `npm run dev` (http://localhost:3001)