https://github.com/brianruizy/bookomate
📅 Smart, cloud-based, and lightweight calendar booking web-application. BookO'Mate
https://github.com/brianruizy/bookomate
Last synced: 6 months ago
JSON representation
📅 Smart, cloud-based, and lightweight calendar booking web-application. BookO'Mate
- Host: GitHub
- URL: https://github.com/brianruizy/bookomate
- Owner: BrianRuizy
- Created: 2020-06-03T13:10:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T04:20:06.000Z (almost 3 years ago)
- Last Synced: 2025-02-13T23:25:00.351Z (8 months ago)
- Language: HTML
- Homepage: https://bookomate.herokuapp.com/
- Size: 188 KB
- Stars: 24
- Watchers: 5
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# 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](https://www.postgresql.org/download/) 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](https://github.com/Bookomate/bookomate/fork) this repository and
[Clone](https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-clone) to your local machine. Then **cd** into the project
```bash
git clone https://github.com/your_username/bookomate.git
cd bookomate
```
2. Create your virtual environment, and activate it.
```bash
python -m venv env
source env/bin/activate # Linux/Mac
env\Scripts\activate # Windows
```
3. Install dependencies
```bash
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=
export SECRET_KEY='PUT-YOUR-SECRET-KEY-HERE'
export DATABASE_URL='postgres://USER:PASSWORD@HOST:PORT/DB_NAME'
```
For Windows use:
```
set DEBUG=
set SECRET_KEY='PUT-YOUR-SECRET-KEY-HERE'
set DATABASE_URL='postgres://USER:PASSWORD@HOST:PORT/DB_NAME'
```
5. Migrate your database
```bash
python manage.py migrate
```
6. Run local server to verify, and **DONE**!
```bash
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](CONTRIBUTING.md) before you contribute.
### Contributors
This project exists thanks to all the people who [contribute](CONTRIBUTING.md)!
[](https://sourcerer.io/fame/BrianRuizy/BrianRuizy/bookomate/links/0)[](https://sourcerer.io/fame/BrianRuizy/BrianRuizy/bookomate/links/1)[](https://sourcerer.io/fame/BrianRuizy/BrianRuizy/bookomate/links/2)[](https://sourcerer.io/fame/BrianRuizy/BrianRuizy/bookomate/links/3)[](https://sourcerer.io/fame/BrianRuizy/BrianRuizy/bookomate/links/4)[](https://sourcerer.io/fame/BrianRuizy/BrianRuizy/bookomate/links/5)[](https://sourcerer.io/fame/BrianRuizy/BrianRuizy/bookomate/links/6)[](https://sourcerer.io/fame/BrianRuizy/BrianRuizy/bookomate/links/7)