https://github.com/richard-degenne/mom-backend

Django backend for the Mom Android application
https://github.com/richard-degenne/mom-backend

Last synced: 11 days ago
JSON representation

Django backend for the Mom Android application

• Host: GitHub
• URL: https://github.com/richard-degenne/mom-backend
• Owner: Richard-Degenne
• Created: 2016-05-11T12:00:51.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-06-03T22:46:14.000Z (over 8 years ago)
• Last Synced: 2024-11-08T10:54:18.091Z (2 months ago)
• Language: Python
• Size: 82 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Mom-backend - Mom is a Organization Manager

===========================================

Mom-backend is a Django backend used by the [Mom](https://github.com/Richard-Degenne/mom)

Android application.

About

-----

This is a school project for IG2I, a computer sciences engineering school

in nothern France.

Installation

------------

### Getting the software

In order to get mom-backend, you can

- Run `$ git clone https://github.com/Richard-Degenne/mom-backend/` ;

- Donwload a ZIP archive by clicking [here](https://github.com/Richard-Degenne/mom-backend/archive/master.zip)

Position into the mom-backed folder by running

    $ cd mom-backend

(`mom-backend-master` if you have used the ZIP archive).

### Installing dependancies

Make sure you have [pip](https://pip.pypa.io) installed. Then run

    $ pip install -r requirements.txt

This will install every library mom-backend needs to run. It can take a while.

### Setting up a database

Create a file in the `mom` folder, called `secrets.py`. In this file, write the following

    DATABASES = {

        'default': {

            'ENGINE': 'django.db.backends.mysql',

            'NAME': '',

            'USER': '',

            'PASSWORD': '',

            'HOST': '',

            'PORT': '',

        }

    }

and replace every angle-bracketed name with consistent values.

Save the file and then run

    $ python manage.py migrate

This is set up the database for mom-backend. It can take a while.

### Setting up a Google API key

Since mom-backend uses the Google API, you need a valid Google API key. Open again the `secrets.py` file, and add the following line.

    google_api_key = ""

Replace the angle-bracketed value by the actual key.

### Installing needed data

Run the following command to feed the database with the necessary data

    $ python manage.py loaddata backend/fixtures/data.json

### Running the server

That's it! You're all set up! You can now run the mom-backend server with the following command.

    $ python manage.py runserver 0.0.0.0:8000

The server will remain active until you `` out of it.