https://github.com/maaack/timekeeper-api
API for Timeline management.
https://github.com/maaack/timekeeper-api
Last synced: 25 days ago
JSON representation
API for Timeline management.
- Host: GitHub
- URL: https://github.com/maaack/timekeeper-api
- Owner: Maaack
- Created: 2017-01-16T02:42:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T00:53:00.000Z (over 3 years ago)
- Last Synced: 2025-11-29T22:07:37.456Z (7 months ago)
- Language: Python
- Size: 193 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Time-Keeper-API
An API for managing timelines.
# Basic Idea
Store and retrieve timeline data and relationships between time, events, and actors
# Environment Setup
`docker-compose up`
You'll need to run migrations on the database to get it caught up.
(If you'd like to have docker do this automagically - by all means)
```
$> sudo docker exec -it timekeeperapi_web_1 /bin/bash
timekeeper_web_1$> python manage.py makemigrations
timekeeper_web_1$> python manage.py migrate
```
Go to `http://localhost:8000/`
# Structure
Django-based REST API
`timelines` has most of the meat. API is accessible in both readable HTML or JSON.
# Additional Resources
Writing your first Django App Tutorials: https://docs.djangoproject.com/en/2.0/intro/tutorial01/
Django REST framework Documentation: http://www.django-rest-framework.org/
API Cheatsheet: https://github.com/RestCheatSheet/api-cheat-sheet#api-design-cheat-sheet
REST API Quick Tips: http://www.restapitutorial.com/lessons/restquicktips.html