That will create a dev image on your machine and launch a tiny web server to compile typescript and serve all the fileslite-server
The backend stays the same no matter the version dev or prod.
make devTo stop the docker containers :
make downYou have modified the dev stage of Dockerfile and want them to be taken into account. 2 options:
- Clean all rebuild and serve
make re-dev- Build the images and serve
make build-devYou want to know what commands are available and what they are doing make help will list all the availables commands in the Makefile and will allow you to use them !
make helpThis project has dependencies in order to make it work on your machine you will have to install them. Normally everything works using Docker but it could be usefull to check if they are working.
Please make sure to have a node version >= 20. otherwise you will have some troubles with them. To check use the command :
node -vTo install all the dependencies simply use :
make installThis will create a production ready image, no server web just the compiled ts css and tailwind. That's it ! Everything is served from the nginx image used for frontend.
The backend stays the same no matter the version dev or prod.
To build and launch the project simply use
make prod To stop the docker containers :
make downYou have modified the dev stage of Dockerfile and want them to be taken into account. 2 options:
- Clean all rebuild and serve
make re- Build the images and serve
make buildRead the documentation just here
The API is documented using Swagger/OpenAPI. Once the server is running, you can access the interactive documentation at:
- Development: http://localhost:3000/docs
- Production: http://localhost:3000/docs
The documentation provides:
- Complete list of all API endpoints
- Request/response schemas
- Authentication requirements
- Try-it-out functionality for testing endpoints
We got a wiki ongoing for ALL the subjects treated, database modelisation, modules choosen, tasks repartition, and so on... Visit the link bellow visit wiki