Commit b92dc761 authored by Rigel Kent's avatar Rigel Kent

📝 (refactor readme and place quickstart instructions in wiki)

[skip ci]
parent 3f1f2bb3
Pipeline #205221 failed with stages
in 8 minutes and 19 seconds
......@@ -2,7 +2,7 @@
---
**[Website][website]** |
**[Website][website]** | **[Quickstart][quickstart]** |
**[Create an instance](#package-create-your-own-instance)** |
**[Documentation](#book-documentation)** |
**[Contact][contact]**
......@@ -10,42 +10,9 @@
A self-hosted linguistic corpora exchange platform, that aims to be a simple
gateway to the fediverse for scientific interaction.
-------
## Quick install for Ubuntu
```bash
sudo apt install python3.7 libldap2-dev libsasl2-dev postgresql python3.7-venv python3.7-dev
virtualenv -p python3.7 olkienv
source olkienv/bin/activate
# create the database
sudo -u postgres createdb -U postgres olki
sudo -u postgres createdb -U postgres olki_test
sudo -u postgres psql -c "create role olki with login password 'olki';"
sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" olki
sudo -u postgres psql -c "CREATE EXTENSION unaccent;" olki
cd olki_back
python manage.py migrate
cd ..
```
Then proceed to linux install below.
-------
## Linux install
To get a copy of the source code and run a local development instance:
```bash
git clone https://framagit.org/synalp/olki/olki --single-branch --depth=1
cd olki
make # to see documentation for the main tasks
make deps-dev-be deps-dev-fe
```
---
To see the web client, open two terminals at the project root and source your *olkienv*,
if you created one as suggested in *Quick install for Ubuntu* above.
Type `make serve-dev-be` in one, and `make serve-dev-fe` in the other. Open your browser to https://localhost:3000. See below to run a production instance.
We provide instructions to quickly get up and running: local [quickstart] or [production](#package-create-your-own-instance) documentation.
## :package: Create your own instance
......@@ -106,6 +73,7 @@ version 3 of it, or (at your option) any later version.
[user documentation]: https://framagit.org/synalp/olki/olki/wikis/User-documentation
[admin documentation]: https://framagit.org/synalp/olki/olki/wikis/Admin-documentation
[development documentation]: https://framagit.org/synalp/olki/olki/wikis/Development-documentation
[quickstart]: https://framagit.org/synalp/olki/olki/wikis/Development-documentation#quickstart
[white paper]: https://framagit.org/synalp/olki/documents/software-requirements-specification/releases
[graphql]: # "work in progress"
[activitypub]: https://framagit.org/synalp/olki/olki/wikis/home/ActivityPub-dialect-documentation
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment