Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/selimdev00/just-in-case


https://github.com/selimdev00/just-in-case

Last synced: 2 days ago
JSON representation

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)