Added a README.md that covers local user testing and a link to the production api.
This commit is contained in:
20
README.md
Normal file
20
README.md
Normal file
@@ -0,0 +1,20 @@
|
||||
Local User Testing:
|
||||
|
||||
1. Create a Postgres DB
|
||||
- name: idea_tracker
|
||||
- user: postgres
|
||||
- password: 1234
|
||||
- port: 5432
|
||||
* NOTE: A command you will run later will create the .env file, so feel free to alter that after the fact if you don't want to use those credentials or DB name
|
||||
2. Run the following commands
|
||||
- npm install
|
||||
- npm run migrate:dev
|
||||
- npx prisma generate
|
||||
- npm run setup:env
|
||||
- npm run seed:dev
|
||||
- npm run dev
|
||||
|
||||
Production User Testing:
|
||||
|
||||
- Go to https://idea-tracker-api.onrender.com/api-docs
|
||||
- This will likely take some time unless the server has been used recently. Render shuts it down if there isn't any traffic on their free development servers and I am unwilling to pay to keep it live.
|
||||
Reference in New Issue
Block a user