Lambda Labs Clone - Village Portal (VBB)

Village Portal is a open-sourced school-based mentoring management platform. Development is lead by Village Book Builders volunteers. Village Book Builders accelerates learners globally through virtual mentoring, learning libraries, and special educational community-wide interventions. Village Portal helps schedule hundreds of virtual volunteer mentors in global time zones. Other Features are in development.

This project is broken up into a separate backend and frontend repository. The backend contains the Django project which uses the Django Rest Framework to host a simple API and can be found at backend-vbb-portal. The frontend uses React and queries data from the API.

Installation

npm i -g yarn
run yarn in root of project
Create .env file - example found in .env.sample
yarn dev or yarn start

To Log In for Development

Navigate to your local host ( typically http://localhost:3000) and go to the /signin/ route and log in with an email/pw provided to you as the role you which to emulate (see User types below).

Docs and valuable links

NOTES.MD has been added to the .gitignore file if you'd like to keep a set of notes with your local file.
Swagger docs for the python backend
Note: The v1/, or version, of the end point should be written into the axios call and not added to the root endpoint.

Coding

Examples of component patterns can be found under examples as can redux folder structure.

Testing Notes

NOTE: Phone numbers must be accurate down to the exchange. For the US that means the country code ( 1 ) + area code ( 202 ) + ( 489 ) must be real or the request to the backend will fail. The last four digits can be any number.

Terminology

Users types (found in src/redux/User.redux/User.types.js):
- 'STUDENT'
- 'MENTOR'
- 'TEACHER'
- 'DIRECTOR'
- 'ADVISOR'
- 'HEADMASTER'
Session: Represents the template of a slot ( think of this as the cookie cutter you make the cookies (slots) from )
Slot: Represents an individual meeting created from the session slot