common-cents-api

REST API for expense tracking and budgeting.

Project setup

Note: use no less than a currently supported LTS version of Node.

Install dependencies:

npm install

Run Locally

By default, the API looks for a locally running Postgres instance, which can be satisfied by running the following docker container:

docker run --name common-cents-db -e POSTGRES_USER=common-cents -e POSTGRES_PASSWORD=CommonCents_123! -p 5432:5432 -d postgres

Alternatively, an external Postgres can be configured through an environment file placed in the root directory (common-cents-api/.env):

# .env
DB_SYNC=true # should be false for production environment
DB_HOST=localhost
DB_PORT=5432
DB_USER=common-cents
DB_PASS=CommonCents_123!
DB_NAME=common-cents

Once the DB is configured/running, the API can be started:

npm run start:dev

Default port (3000) can also be changed in the .env file by setting PORT=xxxx.

Bruno

The included bruno folder contains a collection of calls to make it more convenient to interact with the API. Local calls assume the default NestJS port (3000) is being used.

What's Bruno?

Bruno is alternative to Postman, unlike Postman it's fully open source, requires no subscription or account and collections are easily version controlled.

Resources

Check out a few resources that may come in handy when working with NestJS:

Visit the NestJS Documentation to learn more about the framework.
For questions and support, please visit our Discord channel.
To dive deeper and get more hands-on experience, check out our official video courses.
Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
Need help with your project (part-time to full-time)? Check out our official enterprise support.
To stay in the loop and get updates, follow us on X and LinkedIn.
Looking for a job, or have a job to offer? Check out our official Jobs board.

2.4 KiB Raw Blame History