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

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

Installation

git clone [email protected]: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 developers who want to keep control: read the Manual installation

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

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.

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

Configuring

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

DB_PORT is an environment variable where your Mongo instance is running. The default for a native install (27017) is preserved. Lazy installation runs on 27018 by default.

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.