rateio-web

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 10 Open GitHub ↗

This is a free PWA client for Rateio, using Vue.js, that consumes api hosted on AWS Lambda.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Rateio (Web Client)
Rateio, a [Pitang] app for Time Reporting.  
This is a free [PWA] client, using [Vue.js], that consumes [api] hosted on [AWS Lambda].

## 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

* [Git]
* [Nodejs]
* [Gitflow]

## How can I start?

Well... how about start learning what we use to write this app client?

### Built With

* [Vue.js]
  * [vue-cli]
  * [vuex]
  * [vue-router]
  * [Bootstrap Vue.js]
* [Bootstrap 4.x]
* [SASS/SCSS]
* [PWA]
* [ES6]
* [Nodejs]
* [Git]
  * [Gitflow]

### Installing

Clone the repository to get the source code

```
$ git clone https://github.com/pitangagile/rateio-web.git rateio/web
$ cd rateio/web
```

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?
* **Bruno Monteiro** - [Github](https://github.com/bunomonteiro)
* **Afonso Amorim** - [Github](https://github.com/afonsosa)

## 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.
  * [Vetur] - Vue tooling for VS Code, powered by [vue-language-server]
  * [Debugger for Chrome] - Debug your JavaScript code in the Chrome browser, or any other target that supports the Chrome Debugger protocol.
  * [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.
  * [Vue Peek] - Allows peek and goto definition for Vue single-file components.
* [Yarn] - Fast, Reliable and Secure [Nodejs] Dependency Management.
* [Chrome] - One fast, simple, and secure browser for all your devices.
  * [Vue.js devtools] - Browser devtools extension for debugging Vue.js applications.

## Versioning

We use [SemVer](http://semver.org/) for versioning.

## License

This source code is issued under [Apache 2.0](http://www.apache.org/licenses/LICENSE-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!**

[Pitang]: <https://www.pitang.com/>
[api]: <https://github.com/pitangagile/rateio-api>
[Nodejs]: <http://nodejs.org>
[Git]: <https://git-scm.com>
[Gitflow]: <https://github.com/nvie/gitflow/wiki/Installation>
[Vue.js]: <https://vuejs.org>
[PWA]: <https://github.com/vuejs-templates/pwa>
[Bootstrap 4.x]: <https://getbootstrap.com/docs/4.1/getting-started/introduction/>
[Bootstrap Vue.js]: <https://bootstrap-vue.js.org>
[SASS/SCSS]: <https://sass-lang.com/>
[PWA]: <https://developers.google.com/web/progressive-web-apps/>
[AWS Lambda]: <https://aws.amazon.com/lambda/>
[ES6]: <http://es6-features.org/#Constants>
[Vuex]: <https://github.com/vuejs/vuex>
[vue-router]: <https://github.com/vuejs/vue-router>
[vue-cli]: <https://github.com/vuejs/vue-cli>
[Visual Studio Code]: <https://code.visualstudio.com/>
[vetur]: <https://marketplace.visualstudio.com/items?itemName=octref.vetur>
[vue-language-server]: <https://github.com/vuejs/vetur/tree/master/server>
[Debugger for Chrome]: <https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome>
[GitLens]: <https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens>
[Eslint]: <https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint>
[Chrome]: <https://www.google.com/chrome/>
[Vue.js devtools]: <https://chrome.google.com/webstore/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd>
[Import Cost]: <https://marketplace.visualstudio.com/items?itemName=wix.vscode-import-cost>
[Vue Peek]: <https://marketplace.visualstudio.com/items?itemName=dariofuzinato.vue-peek>
[yarn]: <https://yarnpkg.com/en/>

rateio-web

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README