diff --git a/README.md b/README.md index 00a13b1..859c39d 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,38 @@
A progressive Node.js framework for building efficient and scalable server-side applications.
- - - +DApp for interacting with Smart contracts using Typescript/Node.js. Currently supporting auction API
## Description [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. -## Installation +## Configuration ```bash -$ npm install -``` - -## Running the app +unzip secrets_example folder -```bash -# development -$ npm run start +1. Make sure .env and database.env is in the root of the project. - Used for secrets for app and database +2. Make sure you have config folder in the root and there is a json file inside that named database.json + - Used for Database migrations. This project used sequelize_migrations -# watch mode -$ npm run start:dev -# production mode -$ npm run start:prod ``` -## Test + +## Running the project ```bash -# unit tests -$ npm run test +# development +$ docker compose up -# e2e tests -$ npm run test:e2e +# To make sure every dependencies are currently installed, Please run ;) +$ docker-compose up && docker-compose build --no-cache && docker-compose up -# test coverage -$ npm run 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](https://docs.nestjs.com/support). ## Stay in touch -- Author - [Kamil MyĆliwiec](https://kamilmysliwiec.com) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) - -## License - -Nest is [MIT licensed](LICENSE). +- Author - [Ashok Sekar](https://ashoksekar.com) +- LinkedIn - [Ashok Sekar](https://www.linkedin.com/in/imashok02)