joatu

TODO: Put more badges here.

TODO: Fill out this long description.

Background
Install
Usage
Maintainers
Contribute
License

Background

You need to have python 3.6 and Pip install on your computer. I use Postgresql (version 10) for the database but you can use the sqlite3 that is the default database included with Django. i work with a virtual environment using virtualenv.

Install

clone the project on your computer:

git clone https://github.com/moileretour/joatu.git

If you use Postgresql, first follow the instruction for the installation on you OS https://www.postgresql.org/. Then you need to create a user called "admin" with the password "Pass123". then create a database called "joatu" and owned by the user "admin".

Then create a virtual environment : for Linux or MacOs:

python3 -m venv myvenv

for Windows :

python -m venv myvenv

you can now activate the virtual environment : for Linux or MacOs:

source myenv/bin/activate

for Windows :

myvenv\Scripts\activate

you should now see in your terminal

(myvenv) user\...

Now we need to install Django and all the packages.

pip install -r requirements.txt

you should now have in your myvenv/Lib/python3.6 (for linux and mac)/site-packages all the packages installed.

if you want to use the sqlite3 instead of postgresql, you can go to :

joatu/settings/base.py

and replace:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'project',
        'USER': 'admin',
        'PASSWORD': 'Pass123',
        'HOST': 'localhost',
        'PORT': '',
    }
}

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': 'mydatabase',
    }
}

Migrate the database :

python manage.py migrate

Create a superuser :

python manage.py createsuperuser

it will ask you for your name, email and password.

you can now launch the server:

python manage.py runserver

You can now access to the website on http://localhost:8000 if you are logged with your superuser account, you can go to the admin part of the website http://localhost:8000/admin

you can create others users, projects, offers, demands, hubs. from the admin page you can give CAPs to the others users in the wallet section. The front has been coded in HTML, CSS, Javascript(Jquery) and the focus has been on the mobile version, so it is better to look at it with a mobile resolution (with chrome, open the developer view "F12" and click on Toogle Device Toolbar button.

Usage

Maintainers

@moileretour

Contribute

See the code of conduct file!

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

realrhys/joatu