jesuschm / zoughts

This is not a famous app that publish short ideas and so on

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Requirements

About The Project

Example project built using Django, Graphql and PostgreSQL.

To see the list of features done and which ones are still in develop you can read the following file: Requirements.md

There is a Postman collection with all the queries and mutations available (here!).

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Python 3
• Pip
• Docker engine
• Docker-compose

Installation

1. Clone the repo

   git clone https://github.com/jesuschmn/zoughts.git

2. Docker compose

  docker-compose up -d

3. [Optional] Create a superuser

docker exec -it container_id python manage.py createsuperuser

For development, with the repo cloned, you have to do the following:

1. Create and activate the virtual environment (info)
2. Install requirements

  pip install -r requirements.txt

3. Change the settings of the projects. Specifically, the DATABASE HOST value like this:

DATABASES = {
    'default': {
        ...
        'HOST': 'localhost',
        ...
    }   
}

4. Then up the postgresql database with the following command:

  docker-compose up -d bd

5. Last, just start the server executing:

  python manage.py runserver

And start coding and chill.

Usage

To use the API you have to:

1. Register an user.
2. Verify your account

Then you can use the token got to access to the rest of the API (create/list ideas, search users and request connections, restore your password, etc.).

Contact

Jesús Chacón - Twitter - [e-mail]

Project Link: https://github.com/jesuschmn/zoughts