Skip to content

Latest commit

 

History

History
129 lines (84 loc) · 3.88 KB

README-devs-design-en.md

File metadata and controls

129 lines (84 loc) · 3.88 KB

Developers

This project would not be possible without other developers contributing their time. If you find an error please create an issue and if you can fix it we invite you to create and submit a pull request 😄.

We have a chat room - #horas-project to help the team communicate and coordinate. If you need an account you can create one here.

Please take a look at our issue list for ideas on what to work on or add your own:

Running the project

There's a couple of ways to run this project locally:

Option 1: Docker

Installation

Linux

You can find instructions on how to install Docker for a number of Linux distributions here.

Popular distributions:

Mac OS or Windows

The best/easiest way to have Docker on your Mac or Windows PC is using Docker Desktop.

** Creating Horas Docker images **

# Clone the repo
$ git clone https://github.com/Code4PuertoRico/horas.git

# Make a copy of the .env.example file
$ cp .env.example .env

# From the newly cloned repo, install frontend build dependencies
$ cd horas/static
$ npm install

# Build the Docker image and run it in detached mode
$ cd ..
$ docker-compose up --detach

The docker-compose.yml file contains all the configuration needed to have a running instance of Horas.

Now you can point your browser to http://localhost:8000/. To access the admin panel go to http://localhost:8000/admin/, and use the following credentials:

  • username: admin
  • password: abc123

Option 2: Local

Requirements

# Clone the rep
$ git clone https://github.com/Code4PuertoRico/horas.git

# Install build dependencies
$ cd horas/static
$ npm install

# Make a copy of the .env.example file
$ cd ..
$ cp .env.example .env

# Install Python dependencies
$ pipenv install --dev

# Django migrate and initial data load
$ pipenv run python manage.py migrate
$ pipenv run  python manage.py loaddata apps/profiles/fixtures/admin.json

# Run the Djang server
$ pipenv run python manage.py runserver

Now you can point your browser to http://localhost:8000/. To access the admin panel go to http://localhost:8000/admin/, and use the following credentials:

  • username: admin
  • password: abc123
Mac OS users

When installing the Python dependencies with Pipenv:

$ pipenv install --dev

It's possible to get the following error:

src/_pylibmcmodule.h:42:10: fatal error: 'libmemcached/memcached.h' file not found
    #include <libmemcached/memcached.h>
             ^
    1 error generated.

This can happen when libmemcached is not installed on your system. To solve this please install libmemcached:

Using Homebrew

$ brew install libmemcached

Once installed you can go to the following step to continue: $ pipenv install --dev.

Running the Tests

$ pipenv run python manage.py test --configuration=Testing --verbosity=3 --noinput

Designers

We have a dedicated branch for you! We will maintain the most recent design here.