https://github.com/codecademy/deploying-postgres-backend-with-heroku
https://github.com/codecademy/deploying-postgres-backend-with-heroku
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codecademy/deploying-postgres-backend-with-heroku
- Owner: Codecademy
- Created: 2021-07-30T22:05:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-30T22:07:38.000Z (over 4 years ago)
- Last Synced: 2025-08-09T22:41:09.224Z (7 months ago)
- Language: JavaScript
- Size: 23.4 KB
- Stars: 1
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# codecademy-user-directory-api
Node/Express/PostgreSQL REST API to provide basic functionality of a user directory. Users can add new users to the directory, modify existing users, delete users, and view users.
## Running the app
To run locally, `npm install`, then `npm run start`.
This project requires a [PostgreSQL](https://www.postgresql.org/) database to be running locally. Reference the ERD diagram located in the `resources` folder of this repo to view the structure of the tables. You can use [pgAdmin](https://www.pgadmin.org/) to interact with the database manually.
This repo includes an `example.env` file that contains important environment variables for reference. Make sure to create a `.env` file and include all variables found in the `example.env` file, replacing the example values with those specific to your environment/needs.
Once the app is running locally, you can access the API at `http://localhost:`
## Testing
Swagger documentation available at `http://localhost:/docs`
You can use various HTTP clients such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/) to make requests to the API endpoints.
## Resources
- [REST Architecture](https://www.codecademy.com/articles/what-is-rest)
- [Setting up Postman](https://learning.postman.com/docs/getting-started/settings/)
- [Using pgAdmin](https://www.pgadmin.org/docs/pgadmin4/development/getting_started.html)
- [Postgres Cheat Sheet](https://www.postgresqltutorial.com/postgresql-cheat-sheet/)
- [Heroku Postgres](https://devcenter.heroku.com/articles/heroku-postgresql)