Giter Club home page Giter Club logo

daily-kilometer's Introduction

Daily-Kilometer

Build Status Coverage Status

A Django app for tracking my run mileage and times.

This is deployed on Heroku here.

Development server

Backend

Open a terminal in the project root and run pip install -r requirements.txt to download dependencies.

Run python manage.py migrate to build a SQLite database.

You will need a Sendgrid account to get the email backend working. Follow directons on their website to get an api key for sending mail via SMTP and set environment variables for SENDGRID_USER and SENDGRID_PASS.

Run python manage.py runserver for a dev server. The app will automatically reload if you change any of the source files.

Frontend

Open a terminal in the ng-frontend directory and run npm install

Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Docker Compose

Alternatively, you could just run the project in Docker.

Open a terminal in the project root and run docker-compose build to set up your containers.

Run docker-compose up to run the images.

Go to http://localhost:1337/ in your browser.

Running unit tests

Run python manage.py test to execute the tests.

Building the Frontend

The build process uses a Python script called ng2django. So, be sure to use an environment where you have installed dependencies with pip install -r requirements.txt.

Then you can cd into the ng-frontend directory. Run npm run build.

What I learned

  • Django for web development
  • Unit testing in Django
  • CI/CD with Travis-ci, Heroku and GitHub
  • Test coverage reporting with Coverage.py and Coveralls

daily-kilometer's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.