Rateio (API)
Rateio, a Pitang app for Time Reporting.
This is a free AWS Lambda api written with Serverless.
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
How can I start?
Well... how about start learning what we use to write this api?
Built With
Installing
Clone the repository to get the source code
$ git clone https://github.com/pitangagile/rateio-api.git rateio/api
$ cd rateio/api
Install the dependencies
$ npm install
or
$ yarn
Run to see if everything went well
$ npm run start
or
$ yarn start
Deployment
Just run
$ npm run deploy
or
$ yarn deploy
...but don't do that, let our robots do it for you ;)
Who do I talk to if I have questions?
Recommendations
- Visual Studio Code - is a source code editor developed by Microsoft for Windows, Linux and macOS. It includes support for debugging, embedded Git control, syntax highlighting, intelligent code completion snippets, and code refactoring.
- Eslint - Integrates ESLint into VS Code.
- GitLens - Supercharge the Git capabilities built into Visual Studio Code — Visualize code authorship at a glance via Git blame annotations and code lens, seamlessly navigate and explore Git repositories, gain valuable insights via powerful comparison commands, and so much more.
- Import Cost - Display import/require package size in the editor.
- Yarn - Fast, Reliable and Secure Nodejs Dependency Management.
Versioning
We use SemVer for versioning.
License
This source code is issued under Apache 2.0 license, a permissive free license, which means you can modify it as you please, and incorporate it into your own commercial or non-commercial software.
FOSS, oh yeah!