Nobody asked:
RHdevs:
(Coming Soon!) View the App
This projects is build by RHDevs on December. More Details coming soon! :-)
We are a CCA from Raffles Hall, National University of Singapore. Frustrated by the modernisation efforts by the nature of a gigantuan organisation, we've decided to use our knowledge and skills to ease our day-to-day life in the hostel.
With us, we have 2 main departments; The Developers
and The Designers!
To run the application on your local machine, follow the steps below. To view the hosted application, click here instead (Coming Soon!)
Please ensure that you have the following dependencies installed before carrying on!
-
Python 3 and pip3
# MacOS Developers brew install python # Windows ## Refer to https://www.python.org/downloads/ # Debian/Ubuntu sudo apt update sudo apt-get install python3
-
Flask
- Refer to https://flask.palletsprojects.com/en/1.0.x/installation/
pip install Flask
- Refer to https://flask.palletsprojects.com/en/1.0.x/installation/
-
NodeJS and NPM
# MacOS Developers # Windows ## Refer to # Debian/Ubuntu
-
PostgreSQL (?)
# MacOS Developers # Windows ## Refer to # Debian/Ubuntu
-
yarn
# MacOS Developers brew install yarn # Windows ## Refer to https://classic.yarnpkg.com/en/docs/install/#windows-stable # Debian/Ubuntu sudo apt update && sudo apt install yarn
-
Python 3 Virtual Env
## Unix python3 -m venv venv virtualenv venv . venv/bin/activate ## Windows py -3 -m venv venv \Python27\Scripts\virtualenv.exe venv venv\Scripts\activate
Run yarn start:all
or npm run start:all
- Ensure your venv is up (check pre-requisite)
- Run
export FLASK_APP=testpy.py
to set entry file - Run
flask run
to start flask server - Go to http://127.0.0.1:5000/ to view the server
- To share new dependencies, run
pip freeze --local > requirements.txt
- Copy and paste
.env.template
to fill up the env variables and save asfrontend/.env
- run
yarn
in/frontend
to install dependencies - run
yarn start
to start front-end - Go to http://localhost:3000/ to view the frontend
Our Application is currently not yet ready for open source contributions
Distributed under the GPL-3.0 License. See LICENSE
for more information.
Social Media: LinkedIn | Instagram Project Link: Github Repo | Application (Coming Soon!)