Bookomate?

• BookOMate aims at simplifying peer-to-peer calendar booking, with an intuitive design and lightning speed functionality. Also, some integration to existing popular calendar apps.
• This project is inspired by Bookomatic project: https://github.com/KalleHallden/BookOmatic and created to be continuously updated and completely open-source. Contributions welcomed :)

Coming soon!

Installation

Dependencies

These things will need to be installed before developing BookOMate.

• PostgreSQL Is the database used by BookOMate and installation of python dependencies will not work if PostgreSQL is not installed. On Mac Postgresql can be installed using brew brew install postgresql. Windows users can install it with the installer ensuring that postgresql is added to the system path.

Environment Setup

Get the project running, and start coding in just 5 quick steps.

1. Fork this repository and Clone to your local machine. Then cd into the project

   git clone https://github.com/your_username/bookomate.git
   
   cd bookomate

2. Create your virtual environment, and activate it.

   python -m venv env
   
   source env/bin/activate  # Linux/Mac
   env\Scripts\activate  # Windows

3. Install dependencies

   pip install -r requirements.txt

4. Make sure you create file .env in the root directory of the project using .env.template guide and update the values of corresponding environment variables

   or

   make sure you exported the following environment variables

   For Linux/Mac use:

   export DEBUG=<True or False>
   export SECRET_KEY='PUT-YOUR-SECRET-KEY-HERE'
   export DATABASE_URL='postgres://USER:PASSWORD@HOST:PORT/DB_NAME'
   

   For Windows use:

   set DEBUG=<True or False>
   set SECRET_KEY='PUT-YOUR-SECRET-KEY-HERE'
   set DATABASE_URL='postgres://USER:PASSWORD@HOST:PORT/DB_NAME'
   

5. Migrate your database

   python manage.py migrate

6. Run local server to verify, and DONE!

   python manage.py runserver
   
   June 06, 2020 - 11:22:23
   Django version 3.0.7, using settings 'core.settings'
   Starting development server at http://127.0.0.1:8000/
   Quit the server with CONTROL-C.

Contribution

Read our Contribution Guidelines before you contribute.

Contributors

This project exists thanks to all the people who contribute!