diff --git a/README.md b/README.md index 4cece92..cb08e79 100644 --- a/README.md +++ b/README.md @@ -16,19 +16,40 @@ See [releases](https://github.com/ElevenPaths/thethe/releases) ### Installation -First, clone this repository with: +There is a [**install.sh**](https://raw.githubusercontent.com/ElevenPaths/thethe/master/install.sh) script to ease installation. Either download and execute it by doing: ```bash -git clone https://github.com/ElevenPaths/thethe.git +curl -sSL https://raw.githubusercontent.com/ElevenPaths/thethe/master/install.sh | bash ``` -Then, build the images and run the containers +or clone this repository with: ```bash -docker-compose up -d +git clone https://github.com/ElevenPaths/thethe ``` -You should see **thethe** in [https://localhost](https://localhost) after a :coffee: +and inside **thethe** directory, move the install script one level up and execute it: + +```bash +mv thethe/install.sh +./install.sh +``` + +--- + +### Running thethe + +Inside thethe directory: + +```bash +./start.sh +``` + +Are you a developer? + +```bash +./start dev +``` --- @@ -61,20 +82,22 @@ Inside **utils** folder: Make a backup ```bash -backup_thethe_db.sh +backup_thethe_db.sh ``` Restore from a backup ```bash -restore_thethe_db.sh +restore_thethe_db.sh ``` +backup filename is **db.dump.gz** + --- ### External storage -There is a folder called **extenal** for everything theTHE should store outside a database: files, images, etc. +There is a folder called **external** for everything theTHE should store outside a database: files, images, etc. Backup this folder according to your backup policy. @@ -90,40 +113,26 @@ See [updating thethe](https://github.com/ElevenPaths/thethe/wiki/How-to-update-t If you want to collaborate with the project, a development version is provided: -### Get the repositories +Get the repositories: ```bash -git clone https://github.com/ElevenPaths/thethe.git +git clone --recurse-submodules https://github.com/ElevenPaths/thethe.git ``` -Inside **thethe** main repo: - -for the server: +and only for the first time... ```bash -git clone https://github.com/ElevenPaths/thethe_server.git -``` - -for the frontend: - -```bash -git clone https://github.com/ElevenPaths/thethe_frontend.git +cd thethe_frontend +npm install +cd .. ``` -### Docker (don't forget your :coffee:) +Now you have a dev environment. Every time you need to code, just run thethe with: ```bash -docker-compose -f docker-compose_dev.yml up -d -``` - -### Run the frontend -In develop mode the frontnd does not run inside a container, do: +./start.sh dev -```bash -cd thethe_frontend -npm install -npm run serve ``` --- diff --git a/thethe_frontend b/thethe_frontend index ef1d991..5da5433 160000 --- a/thethe_frontend +++ b/thethe_frontend @@ -1 +1 @@ -Subproject commit ef1d991e8d704719a29d4c1cc12b0b2b87ad154b +Subproject commit 5da54337b17c7ee7fa404619404f9e7a1217a0cd diff --git a/thethe_server b/thethe_server index 4b051d5..e84be9f 160000 --- a/thethe_server +++ b/thethe_server @@ -1 +1 @@ -Subproject commit 4b051d5e0b7712eae4ec085b4b57468621a95938 +Subproject commit e84be9f2a110cfc50768a00261e21bea442949ab