Skip to content
This repository has been archived by the owner on Nov 18, 2022. It is now read-only.
/ hackaru-api Public archive

An API server for Hackaru

License

Notifications You must be signed in to change notification settings

hackaru-app/hackaru-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hackaru-api

The API server for Hackaru.
An open source and simple time tracking app.

Maintainability Test Coverage License: MIT

Features

Want to know that you can do with Hackaru?
For more information on the app, please see the main repository README.

Roles

The API server provides REST API to web server and desktop app.

Feedback

Do you find a bug or would like to submit feature requests?
Please let us know via Issues. 😉

Quickstart

You can run Hackaru on your local easily using docker-compose.

It's also necessary to run the web server if you want to login to Hackaru on your browser.
Please see the web server README.

# Clone this repository.
git clone git@github.com:hackaru-app/hackaru-api.git
cd hackaru-api

# Copy and rename env file.
cp .env.sample .env.development

# Set up the database, build assets, etc.
docker-compose -f docker-compose.yml -f docker-compose.dev.yml run api bin/setup

# Try accessing http://localhost:3000 after execution.
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

License