diff --git a/.gitignore b/.gitignore index 73fba8f..6657f92 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ /node_modules /build /assets +!/assets/uploads/.gitkeep /generated/prisma # Logs diff --git a/README.md b/README.md index be93a46..f5c9e9c 100644 --- a/README.md +++ b/README.md @@ -5,30 +5,36 @@ [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 [circleci-url]: https://circleci.com/gh/nestjs/nest -
A progressive Node.js framework for building efficient and scalable server-side applications.
- - - ## Description -[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. +IISA Backend application +Using [Nest](https://github.com/nestjs/nest) framework. ## Project setup +Install packages + ```bash -$ npm install +$ npm install +``` + +Generate Prisma files + +```bash +$ npx prisma generate reset +``` + +Project requires postgreSQL service. + +Create .env file in root of the project, example: + + DATABASE_URL="postgresql://postgres:postgres@localhost:5432/iisa" + HOST_URL="http://localhost:3000" + +Apply Prisma db migrations + +```bash +$ npx prisma migrate reset ``` ## Compile and run the project @@ -44,62 +50,6 @@ $ npm run start:dev $ npm run start:prod ``` -## Run tests +## Swagger -```bash -# unit tests -$ npm run test - -# e2e tests -$ npm run test:e2e - -# test coverage -$ npm run test:cov -``` - -## Deployment - -When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information. - -If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps: - -```bash -$ npm install -g @nestjs/mau -$ mau deploy -``` - -With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure. - -## Resources - -Check out a few resources that may come in handy when working with NestJS: - -- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework. -- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy). -- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/). -- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks. -- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com). -- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com). -- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs). -- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com). - -## Support - -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). - -## Stay in touch - -- Author - [Kamil MyĆliwiec](https://twitter.com/kammysliwiec) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) - -## License - -Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE). - - -## TODO - --fix picture upload --implement picture loader --use leaflet for map implementation \ No newline at end of file +Navigate http://localhost:3000/api to access swagger api documentation \ No newline at end of file