Skip to content

Contributions Welcome: A developer community for everyone with an interest in Technology & Meetups

License

Notifications You must be signed in to change notification settings

Janaki96/my-dev-space

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

My Dev Space

Build Status GitHub license All Contributors PRs Welcome Code of Conduct

A open source developer community to promote local hackathons, conferences, and meetups, mentoring, calls for speakers, and collaboration.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

  • Docker - Used to build, ship, and run all services
  • Python - Dependency Management
  • Node - Used to generate RSS Feeds

Setting up a local development environment

The following steps will check out the repository, install the dependencies needed for the React frontend and run the service on http://localhost.

$ git clone https://github.com/apoclyps/my-dev-space
$ cd my-dev-space
$ docker-compose -f docker-compose-dev.yml up -d

Once the service is up and running, you will need to manually create the required tables in the database and install the optional seed data to complete the local Postgres setup.

$ docker-compose -f docker-compose-dev.yml run users-service python manage.py recreate_db
$ docker-compose -f docker-compose-dev.yml run users-service python manage.py seed_db
$ docker-compose -f docker-compose-dev.yml run events-service python manage.py recreate_db

On subsequent runs (when the above steps have been completed), you can apply new database migrations to your local service by running:

$ docker-compose -f docker-compose-dev.yml run users-service python manage.py db upgrade
$ docker-compose -f docker-compose-dev.yml run events-service python manage.py db upgrade

Alternatively, if you make a change to a model during development, you will need to create and commit a migration file for that service. As a best practice, migration files should be committed independently to code:

$ docker-compose -f docker-compose-dev.yml run users-service python manage.py db migrate
$ docker-compose -f docker-compose-dev.yml run events-service python manage.py db migrate

To load data into the service for development, the recommended solution is to use the load script within the scripts folder to populate the local database. Details on how to configure the script can be found in scripts/README.md.

`./load_data.sh dev`

And to tear down the local development stack, simply run:

$ docker-compose -f docker-compose-dev.yml down

If you wish to populate your local database with events from external services, you can use the steps outlined in the scripts README.

Running the tests

The following will run the unit tests for each respective service:

client
$ docker-compose -f docker-compose-dev.yml run client-test npm test
users-service
$ docker-compose -f docker-compose-dev.yml run users-service python manage.py test
events-service
$ docker-compose -f docker-compose-dev.yml run events-service python manage.py test

Running linting

client
$ docker-compose -f docker-compose-dev.yml run client npm run lint
users-service
$ docker-compose -f docker-compose-dev.yml run user-service py.test --black --pep8 --flakes -vv --mccabe --cov=project --cov-report=term-missing --junitxml=test-results/results.xml
events-service
$ docker-compose -f docker-compose-dev.yml run events-service py.test --black --pep8 --flakes -vv --mccabe --cov=project --cov-report=term-missing --junitxml=test-results/results.xml

Running code coverage

$ docker-compose -f docker-compose-dev.yml run users-service python manage.py cov

Local Postgres Connections

docker-compose -f docker-compose-dev.yml run events-db sh

psql postgres://postgres:postgres@events-db:5432/events_dev

Debugging Python Applications

End to End tests

Integration tests used to evaluate all services behave correctly

$ npm install testcafe -g
$ export TEST_URL='http://localhost'
$ testcafe chrome e2e

Deployment

Deployments to the staging and production environments require a PR to be opened against the staging/production branches; Upon successfully merging a PR into either branch; Travis CI will build, run, test, and deploy the changes to AWS ECS.

Built With

  • React - Javascript client framework
  • Flask - Python web framework
  • Postgres - Relational Database Management System
  • Docker - Build, run, and deploy services
  • Swagger - Generate API documentation
  • Nginx - high-performance HTTP server, reverse proxy

Contributors

A list of contributors who participated in this project.


Kyle Harrison

πŸ’» πŸ“–

Adam Smith

πŸ’»

Ewa G

πŸ’»

Michael Grundie

πŸ’»

DermotMcAteer

πŸ’»

kimmoylan

πŸ’»

Peter Stevenson

πŸ’»

Alistair Brown

πŸ’»

gingerzoealex

πŸ’» 🎨

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

About

Contributions Welcome: A developer community for everyone with an interest in Technology & Meetups

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 61.4%
  • JavaScript 29.1%
  • Shell 6.9%
  • HTML 1.8%
  • Other 0.8%