Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 1.34 KB

Contributing

Project structure

platform
├── free_our_knowledge
│   ├── __init__.py
│   ├── settings
│   ├── resources
│   ├── urls.py
│   └── wsgi.py
├── docker
│   └── Dockerfile
│   └── docker-compose.yml
│   └── entrypoint.sh
├── manage.py
└── requirements.txt

Getting Started

Development installation

  1. CLone the repository locally:
git clone [email protected]:FreeOurKnowledge/platform.git
  1. Create a new virtual environment and activate it:
python3 -m venv fok_env
source fok_env/bin/activate
  1. Install all of the dependencies:
pip install -r requirements.txt
  1. Generate the database tables:
python manage.py migrate --noinput
  1. Start the project:
  python manage.py runserver

If everything works the platform should be available on http://127.0.0.1:8000/.

Docker installation

  1. Build the development image. From the project root:

sudo docker build . -f ./docker/Dockerfile -t fok_platform

sudo docker-compose -f ./docker/docker-compose.yml up --build -d

  1. Check the build is running properly

sudo docker ps

  1. [Configure credentials]??

  2. Open a browser to http://localhost:8080/ to view the application (if using Chromebook, go to http://penguin.termina.linux.test:8080/)