Changelog API
This is a REST API for a changelog application. It allows us to create users, authenticate users, create products, update products, get products, and get updates. It's built with Node, Express, Postgres, Jest, Render for web and db hosting, and uses TypeScript to take advantage of type checked data introspection with Prisma's ORM.
Usage
To use the Changelog, access the deployed API at https://api-design-v4-changelog-web-server.onrender.com/ for requests.
Installation
To build, you will need to connect a database (This application was built with a free Render db).
To install dependencies, run $ npm install or $ npm i.
To initialize Prisma (for setting up your db schema), run $ npx prisma init
-
Add your external db's url and a JWT_SECRET to the
.envfile Prisma created. See Prisma documentation -
Design a schema for your data in
prisma/schema.prismaonce created. -
Run a migration to sync the db with your Prisma schema
$ prisma migrate dev --name <name>
To begin interacting with your Changelog database, run $ npm run dev
- Recommend using the VS Code Thunder Client extension for requests.
- For authentication, make a a POST to
/userwith ausernameandpasswordto create a user, get a JWT, and get started.
To view and edit in Prisma Studio, run $ npx prisma studio
Credits
This is the completed project from Scott Moss's API Design v4