-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from FreeOurKnowledge/pledge-optional
Pledge optional
- Loading branch information
Showing
2 changed files
with
57 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,10 +2,62 @@ | |
|
||
## 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 | ||
``` | ||
|
||
2. Create a new virtual environment and activate it: | ||
|
||
``` | ||
python3 -m venv fok_env | ||
source fok_env/bin/activate | ||
``` | ||
|
||
3. Install all of the dependencies: | ||
|
||
``` | ||
pip install -r requirements.txt | ||
``` | ||
|
||
4. Generate the database tables: | ||
|
||
``` | ||
python manage.py migrate --noinput | ||
``` | ||
|
||
4. Start the project: | ||
|
||
```python | ||
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 | ||
|
@@ -19,3 +71,5 @@ | |
3. [Configure credentials]?? | ||
|
||
4. Open a browser to http://localhost:8080/ to view the application (if using Chromebook, go to http://penguin.termina.linux.test:8080/) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters