Skip to content

README.md

Latest commit

 

History

History
191 lines (148 loc) · 5.15 KB

README.md

File metadata and controls

191 lines (148 loc) · 5.15 KB

alt text

Api

Index

  1. Content
  2. Necessary programs
  3. How to clone
  4. Installation
  5. Private keys
  6. Run en producción
  7. Slack app configuration

This is the backend of the Core Code Platform system.

1. Content

Controller backend of our user frontend (student-app) and management frontend (management-app). The project is carried out in:

  • Node.js

  • express.js

  • sequelize (with Postgres database)

2. Necessary programs

To be able to use the project in localhost it is necessary to clone and have some programs:

  • Nodejs v18.12.1 Higher.
  • PostgreSQL PostgreSQL (can be optional, sequelize allows you to configure other databases).
  • Development IDE of your convenience Example VS Code
  • PostMan for APIS testing. (Optional)
  • Git to be able to manage the versions.

3. How to clone

As the project is in a workspaces we will clone everything:

cd existing_folder
git clone https://github.com/corecodeio/platform.git

4. Installation

As the project is in a workspace we will install the dependencies of all the projects locating ourselves in the main directory or if we want only the backend positioning ourselves in "/api":

npm install

5. Private keys

We will create a file called .env positioned in "/api"

  • Server configurations: these variables are for basic configuration and development mode.
    • SERVER_PORT: api project execution port
    • SERVER_MODE: variable to run development mode, should be filled with the value "dev".
    • SERVER_DEVELOPMENT_USER_ID: It is the user ID of the main stytch account that will be used for development when assigning it, you can execute the preload command and give it the main role and all the permissions to be able to do tests more easily in local mode
    {
    "preload": "node ./src/development-data/index.js"
}
    • CHANNEL_SLACK_CELEBRATION: Slack channel ID for celebration messages. make sure the slack app is present in the channel in order to run properly
    • CALENDAR_CELEBRATION_ID: ID of the google calendar that will be used to schedule the celebrations
    #Server configurations
    PORT=3001
    SERVER_MODE=dev
    CLIENT_URL=http://localhost:3500
    SERVER_DEVELOPMENT_USER_ID=
    CHANNEL_SLACK_CELEBRATION=
    CALENDAR_CELEBRATION_ID=
  • Database configurations: These variables are for the connection to the database, the api project is configured to use Postgresql with the "sequelize" ORM.
    #Database configurations
    SERVER_DB_USER=
    SERVER_DB_PASS=
    SERVER_DB_HOST=
    SERVER_DB_PORT=
    SERVER_DB_NAME=
  • stytch api access data.
    #Stytch configurations
    STYTCH_PROJECT_ID=
    STYTCH_SECRET=
  • Slack configurations: variable necessary for the socket connection of our slack app. if SERVER_MODE_SLACK is filled with "dev" the console logs additional data
    #slack configurations
    SLACK_BOT_USER_OAUTH_TOKEN=
    SLACK_APP_LEVEL_TOKEN=
    SERVER_MODE_SLACK=
  • Google calendar configuration: variable needed for connection with google api. Here is a video detailing how to configure the google calendar api
    #google configurations
    GOOGLE_CLIENT_ID=
    GOOGLE_SECRET_CLIENT=
    GOOGLE_REFRESH_TOKEN=

6. Run en producción:

Eliminate the "SERVER_MODE" key and change the others to those corresponding to the production environment. When the keys are in production mode, execute the command:

npm run start

In case of being positioned in the central directory of the workspaces use:

npm run start:api

7. Slack app configuration

  • In order to configure the SLACK environment variables, we must first create an application at https://api.slack.com/ and install it in our slack workspace.

Image

  • Before we can install the application we must create permissions.

Image

Bot Token Scopes

reactions:write
pins:write
groups:write
channels:manage
chat:write
users:write
im:write
files:write
im:read
mpim:read
groups:read
channels:read
users:read.email
reactions:read
im:history
mpim:history
groups:history
channels:history
app_mentions:read
users:read
team:read
usergroups:read

User Token Scopes

admin.usergroups:write
channels:read
channels:write
files:write
groups:read
groups:write
im:write
mpim:read
mpim:write
pins:write
  • Enable socket connection mode.

Image

  • We generate our application level token for the environment variable SLACK_APP_LEVEL_TOKEN.

Image

  • we copy the user Oauth Token to the environment variable SLACK_BOT_USER_OAUTH_TOKEN

Image