Web server and application server that will serve static content and dynamic content over HTTP. It is powered by Node, Strapi, and PostgreSQL. The file structure is defined by Strapi and is documented here.
server depends on other services and must be run with the rest of the application. See the project development setup for instructions.
yarn build-client- Build client and add it to the public folderyarn build- Build the strapi admin panel
All assets in the public directory will be served. The specifics are defined here.
When Docker builds the production container, it builds client and adds it to public/client
The proxy middleware handles serving client/index.html, passing off all client routes to react. All other client assets are served by strapi as public assets. The middleware was implemented to solve manual navigation to a non-root client route responding with a 404. Read more about this here.
Built with Node, Koa, and Bookshelf, the REST API enables CRUD functionality with the application's content. Authentication is enabled via JWTs. The dbms is PostgreSQL.
The latest API documentation is available on Strapi Documentation after you started your local development. You can view example request/responses and test it with your jwt token.
Mentors use the local provider routes, /auth/local and /auth/local/register, to login and register. Students login by joining a session with the route /sessions/join/:code. In both cases, a JWT will be issued on a successful response. Subsequent requests will need to send this JWT as a Bearer token. Read more about that here.
The permissions policy is run as a middleware on all requests. It will pull the user and their role, which will be executed against the respective policy. Custom logic has been added to handle student JWTs as student auth is not apart of the
/authcontroller group.
Each endpoint corresponds to an entity from the ER digram, a content type in the admin panel, a folder in the ./api directory, and a database table.
Each and every endpoint can be interacted with by using the following method and path combinations.
| Method | Path | Description |
|---|---|---|
| GET | /{endpoint} | Get a list of entries |
| GET | /{endpoint}/:id | Get a specific entry |
| GET | /{endpoint}/count | Count entries |
| POST | /{endpoint} | Create a new entry |
| DELETE | /{endpoint}/:id | Delete an entry |
| PUT | /{endpoint}/:id | Update an entry |
Read the full documentation on the api endpoints.
We intergrated the Stapi Email Plugin with SendInBlue to send Bug report and forgot password emails.
We also uses Strapi Documentation Plugin to document our backend api end point as well as testing it on the fly.
Built with React and served by Node, the admin panel allows for full customization of the server. Here you can create new content types and their corresponding endpoints, configure roles and permissions, and much more. The interface itself can be customized and configured as needed.
In some cases /admin may be blank, in this case
yarn buildneeds to be run from the docker container
Read the full documentation on the admin panel.