Neomad website

Neomad is a open-source community project for nomad workers and people willing to nomadize themselves.

Requirements

• Git
• Python3.6 or above
• Docker-compose

If you don't have/want to use docker, you can process to the Manual installation section.

Installation

git clone git@github.com:neomad-team/neomad.org.git neomad
cd neomad

The next steps are also simple. Choose your story:

• for lazy developers: go to lazy developer install
• for lazy testers: choose the full-docker install
• for developers who want to keep control: read the Manual installation

You may then want to insert dummy data use make fixtures.

Lazy developer installation

make install

You're done. It's called lazy for a reason! Open your browser at http://localhost:5000/login.

Lazy you!

Next times you want to run your project, you can do the following:

make start

Full-Docker Installation

First of all you should create your required files: make install_files.

In the settings.py file, set the DATABASE = {…, 'host': 'db', …} to connect the server to the database ('db' is the actual name you want as host, it is the name of the docker link).

Then run docker-compose up and open your browser at http://localhost:5000.

You can access your python server machine with docker-compose exec -it web (you may need it to create a user for example).

The sources in your docker server are in the /app folder (cd /app).

Manual installation

Are you a Python warrior willing to take full control of your environment?

View the makefile file in the install section and tweak your commands. It's been made to be easily readable.

Note that you can either have your own MongoDB or use Docker even if it's only for running a database: docker-compose up -d db.

Configuring

In the previous commands you created a file called settings.py at the root of the project. Tune your settings there.

Running test

Activate your python virtual environment (with source venv/bin/activate). Then launch your test with python -m unittest.

Deploying

Deployment is processed through the SSH command ssh neomad. You should ensure that your ssh_config is configured prior to continue.

Run the following task to deploy in preprod:

make prepare-deploy env=preprod
make deploy preprod

replace preprod with prod for running in production.