Skip to content

mrkhairullah/backend.recyclelify

 
 

Repository files navigation

♻️ Recyclelify [Backend]

Tools Required:

  • Git: Recommended version 2.xx+
  • Node JS: Recommended version 18+ (Including NPM as per Node JS version)
  • PostgreSQL: Recommended version 14+
  • Text Editor: Recommended Visual Studio Code
  • Postman (Optional)

Needs:

  • Public & Secret Key Uploadcare

Steps To Run The App

  1. Clone this repository
  2. Duplicate the .env.example file and rename it to .env
  3. Fill in the environment variables:
    • PORT can be filled with 3000 or 9000 as needed.
    • SECRET_KEY can be filled as desired and it is recommended not to fill it with a common word or key
    • UPLOADCARE_PUBLIC_KEY and UPLOADCARE_SECRET_KEY are filled with the keys obtained on the API KEYS page in the Uploadcare dashboard (Make sure to register first).
    • DATABASE_URL and DIRECT_URL are filled with the Connection String of the PostgreSQL Database, if running it using a local database then it can be filled with the same value, unless using a Supabase.
  4. Install the dependencies with the npm i command
  5. Run this command to migrate and seed the database:
    • npx prisma db push: for Migration
    • npx prisma db seed: for Seeding
  6. There are 2 commands to run the program:
    • npm start: for the Production phase
    • npm run dev: for the Development phase

For application guidelines, refer to this document: https://docs.google.com/document/d/1ObEXkSjpW8vGStFaUIGuQuNCoUmteij4ZBRhaQEBIqs/edit?usp=sharing

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%