Skip to content
REST API for Tax-E Mobile App
JavaScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
controllers
helpers
middlewares
models
routes
scripts
services
test
.dockerignore
.gitignore
.travis.yml
CHANGELOG.md
Dockerfile.production
Dockerfile.test
README.md
app.js
config.sample.json
docker-compose.test.yml
docker-compose.yml
package-lock.json
package.json
routes.js

README.md

Tax-E REST API · Build Status

An express.js REST API that is used to serve the Tax-E Android App. Handles User Authentication, Bookings and Company Management.

Installing / Getting Started

Firstly, rename 'config.sample.json' to 'config.json', and input necessary values (see configuration). Then, in order to generate SSL certificates, navigate to ./scripts and execute the following:

sh generate-cert.sh

Once all configuration is handled, simply run the following npm script. It will build, and spin up a docker container for both the database and the API.

npm run-script debug

Developing

Built with

Node.js, Express.js, MongoDB

Prerequisites

Docker, Docker-Compose

Versioning

Project uses Semantic Versioning 2.0.0

Configuration

Environment Variables

If using environment variables, set MONGO_URI to the connection URI of your mongodb database. Set JWT_EXPIRY to the amount of time (in seconds) before the jwt token expires. Set JWT_SECRET to your jwt secret key.

Configuration File

If using a config file, rename 'config.sample.json' to 'config.json', then input necessary values.

Tests

Run all chai tests in mocha environment using the following command

npm test

Api Reference

https://github.com/rhys3010/taxe-api/blob/master/routes/README.md

You can’t perform that action at this time.