Village Portal is a open-sourced school-based mentoring managment platform. Development is lead by Village Book Builders volunteers. Village Book Builders accelerates learners globally through virutal mentoring, learning libraries, and specialed educational community-wide interventions. Village Portal helps schedule hundreds of virtual volunteer mentors in global time zones. Other Features are in development.
New Front-End of Village Portal @ https://github.com/VilllageBookBuilders/frontend-vbb-portal.git
New Back-End of Village Portal @ https://github.com/VilllageBookBuilders/backend-vbb-portal.git
To Help, questions, comments, concerns, Email US at @ support@villagebookbuilders.org. Our DEV Taskboard: https://app.zenhub.com/workspaces/villagebookbuilders-5f662d2ba0525c27f3a90388/board. Join our weekly meetings: https://meet.google.com/btm-gwyo-uwr on Saturday at 9AM
This project is broken up into a backend and frontend. The backend contains the Django project which uses the Django Rest Framework to host a simple API. The frontend uses React and queries data from the API. The backend is found in the django apps: api and vbbportal. The frontend is a react app, and most of the code is located in the src folder.
Install python and node.js beforehand!
Run the following commands inside of the repository folder to get started:
(OSx/Linux)
virtualenv env
pip install -r requirements.txt
npm i
npm run build
python manage.py runserver(Windows)
py -m pip install --user virtualenv
py -m venv env
env\Scripts\activate.bat
pip install -r requirements.txt
npm i
npm run build
python manage.py runserver
python manage.py migrateThese commands (respectively)
- virtualenv env (create a virual environment for all of your python packages) (you will then need to enterthat environment with source env/bin/activate
- pip install -r requirements.txt (install all of the python packages listed in requirements.txt)
- npm i (install the node_js modules) (node js needs to be installed on your computer first)
- npm run build (this will create a static build file so that django can host the react app)
- python manage.py runserver (this will run your server locally)
For the Youtube tutorials associated with this code (and preparing it for production), click here https://youtu.be/uZgRbnIsgrA
*Note: run server on local Host : http://localhost:8000/signin *Note: to access, django admin, go to http://localhost:8000/admin/ Username and Password: $$; Note: Discard any database changes on your local server (DON'T PUSH)
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify