projects-api

Hi, welcome to the "projects-api" repo. Please use this readme as an introduction to get you started on working with this repo.

Table of Contents

1. Get Started
2. Routes
3. File Structure
4. Error Handling
5. Additional Info

Additional info can also be found in the Engineering Wiki section of Notion.

---

Get Started

To get started, please follow these instructions:

1. Ensure you have the .env file set up. Please place it in the root directory of this repo (same directory-level as this README.md)

2. Check the package.json and make sure your PORT is configured properly. It should read:

  // Located in package.json, 'scripts', 'start'
  // for PORT=30##, # can be any integer from 0-9. (i.e. 3004)

  // Windows
  set PORT=30## && react-scripts start

  // Mac & Unix
  PORT=30## react-scripts start

You should probably make sure this is the same PORT used in the other projects when they need to refer to this repo.

3. Make sure that you have access to Naya npm packages. Login with same email using npm login.

4. Install dependencies using npm install or yarn install

5. Run with npm start or yarn start to start in production environment, Run with npm run dev or yarn run dev to start in development environment

---

Routes

For information about all the CRUD actions you can perform in this repo, please refer to our wiki.

---

File Structure

Here are some of the folders/files we will talk about in this section:

  repo
   |--> actions/
   |--> middlewares/
   |--> models/
   |--> routes/
   |--> services/
   |--> .env

There are other folders and files found in this repo (such as src/public/) that will not be discussed in this chapter (most of them are used for configuration)

Folders and Files

Here we will go over the general purposes for each of the folder/file (mentioned above).

1. actions/

     src
     |--> actions/

   This folder is used to contain all the side-effect actions that occur from a route. It is common to have CRUD requests to other APIs in this folder.

   Example: After an ecosystem user has updated their estimation, we would want to email an admin about this update. This folder will contain the logic used to send the email.

2. middleware/

     src
     |--> middleware/

   This folder is used to contain all custom middlewares used in this repo. For middleware initialization from external packages (npm), please initialize in the 'services' folder.

3. models/

     src
     |--> models/

   This folder is used to contain all the Mongoose schema's used throughout this repo. If necessary, sub-directories can be created for organization purposes.

4. routes/

     src
     |--> routes/

   This folder contains all routes available from this repo. If necessary, sub-directories can be created for organization purposes.

   NOTE: Before writing a new route, please refer to the wiki and see if there are existing routes that will satisfy your requirements.

5. services/

     src
     |--> services/

   This folder contains all external service initialization. (i.e. Firebase-admin, SendGrid)

6. .env

    repo
     |--> .env

   .env is for our sensitive constants, you can find a copy for local usage in our Notion

---

Error Handling

All errors that occurs in a route should return a response with this template. You can extend this template and add additional fields but this is the bare minimum.

{
  status: false,
  message // describes why the request failed
}

The message should be of type string and should be descriptive enough to highlight the problem with the developer's request. The message can also provide hints for the developer on how to fix their request.

As a rule of thumb, there should be error messsages if:

• a request payload is missing required fields
• failed database query
• failed validation check of any data (i.e. non-valid email is provided for a sign-up)

Also remember to return your error messages if it is not at the end of a closure.

if (!user) // this will throw an error
  res.json({ status: false, message: 'No user found with the provided credentials. Invalid email/uid' })


if (!user) // this will not throw an error
  return res.json({ status: false, message: 'No user found with the provided credentials. Invalid email/uid' })

TODO: Standardize status codes? Do we even need status codes as it's redundant?

---

Additional Info

Here are some helpful links to wikis that cover topics missed in this readme:

• Coding style/best practices [link]
• Authentication/Firebase [link]
• Testing/QA [link]

Dependencies

TBD? What rules for dependencies?