🌿 Greenly Setup

Preface

• Latest npm and Node.js are required
  • Debian:

    sudo apt update;
    sudo apt install nodejs;
    sudo apt install npm;
    

Dependencies

• Run npm install to install all listed dependencies. For more details check package.json.

Database & Authentication

1. To run this project, follow these steps inside /server. Create a .env file. Populate it with information regarding database access and local machine hosting port, following the correct format. Here's an example:

   PORT=8080
   DATABASE_URL=mysql://janedoe:mypassword@localhost:5432/mydb
   GOOGLE_API_KEY=...
   JWT_SECRET=...
   JWT_EXPIRATION=...
   ...
   

   Replace 8080 with your desired hosting port (remember you may need elevated privileges if you'd like to use port 80).
   Check the Prisma Docs for more information regarding connection URLs.
2. If you'd like to run the project as is, you can skip to the next step.
   1. Otherwise, if you'd like to change the database structure (not advised), you'll have to compile a new prisma/scheme.prisma file. More information here. Advance only when your prisma/scheme.prisma file is ready.
3. We've built Greenly's database in MySQL, which was then Introspected into a Prisma Data Model, allowing us to use the Prisma Client.
   1. As such, if you're using the provided prisma/scheme.prisma file or have already built your own valid file, run npm install @prisma/client
4. That's it! You're locked and loaded! Keep in mind: if you ever change your .env file, you'll have to regenerate the Prisma Client. This can be done in one of the following ways:
   1. Rerunning npm install @prisma/client
   2. Running npx prisma generate

Running

• Backend server logic (express.js) can be run by moving into /server and executing npm start.
  • If you're looking for an easier development environment, run npx nodemon so that the server auto-reloads with changes and/or crashes.
    • SSL support can also be disabled by including the flag --SSL=False. If disabled, the server will stop enforcing SSL on all requests. Use only for development purposes, otherwise heavily discouraged.
    • You can also enable request logging to stdout by including the -l or --request-logging flag.
    • Additionally, use the -m or --database-monitoring flag for debugging purposes, where all database operations will be explicit and logged to stdout.
• The Vue.js server (frontend) can be run by moving into /client and executing npm run serve.

Notes

• For all hashing purposes, this project uses bcrypt, a Blowfish-cipher-based cryptographic algorithm which has stood the test of time.

Greenly Team 🌿 2022