README.md

A progressive Node.js framework for building efficient and scalable server-side applications.

📚 About The Project

I wanted to try another framework, instead of Express, so I decided to use Nest.js.

At first, I was a little confused, but as time went by I could figure how to make this simple project work, and this is thanks to the awesome documentation provided by Nest.

My first impression of this framework was amazing. I really enjoyed using the decorators, which gave me a sense of customization and freedom to develop new features.

I'm looking forward to building more things with this framework soon.

🚀 Installation

1. Clone the repo

   git clone https://github.com/lucfersan/nestjs-crud

2. Install NPM packages

   yarn

3. Create a docker container

   docker run --name first_nest_app -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

4. Create database named: first_nest_app

💻 Running the app

# development
$ npm run start
or
$ yarn start

# watch mode
$ npm run start:dev
or
$ yarn start:dev

# production mode
$ npm run start:prod
or
$ yarn start:prod

🧪 Test

# unit tests
$ npm run test
or
$ yarn test

# e2e tests
$ npm run test:e2e
or
$ yarn test:e2e

# test coverage
$ npm run test:cov
or
$ yarn test:cov

👍 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.

🗞️ License

Nest is MIT licensed.

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📧 Contact

Lucas Fernandes - fernandes.lucas11@outlook.com