Charge Beacon is a tool that allows you to track and receive updates on EV charging station installations and availability in specific regions, primarily in North America. It is a free tool that is open to the public. Hosting is provided courtesy of the project maintainers.
- Python 3.11 or later
- Docker for development and testing
-
Clone the repo
git clone https://github.com/charge-beacon/charge-beacon.git
-
Create a virtual environment
python3 -m venv .venv
-
Activate the virtual environment. You will want to do this every time you begin development.
source .venv/bin/activate -
Install the required packages. This file changes frequently, so you may want to do this whenever pulling new changes.
pip install -r requirements.txt
-
Start docker containers. These are required to run the app as well as run tests.
docker-compose up -d
-
Create the database. This is required any time a database migration is added. Run it any time you pull changes.
python manage.py migrate
-
Create a superuser. Only required once, or whenever you nuke the DB.
python manage.py createsuperuser
-
Run the development server
python manage.py runserver
-
Open your browser and navigate to
http://127.0.0.1:8000
Please feel free to contribute bug fixes and new features. Pull requests are welcome. Please make sure to include tests!
Join in our Discord to discuss the project and get help.