Soon we will add the documentation information in a link
## :rocket: Custom Aruppi API Link
Link to access the [Aruppi API](https://aruppi-api.jeluchu.now.sh/api/v2)
## 📚 **Development Diary**
Describe the purpose of the project and give clues about what the code does.
For more information go to the following link [Diary Reference](./development_diary/README.md).
## **:wrench: Developer usage**
### **Set up project**
@ -46,25 +33,24 @@ you need to have installed these versions:
Then:
- Choose a folder project in your system and switch in `cd [folder path]`
- Clone the repo in your folder path `git clone https://github.com/aruppi/aruppi-api`
- Clone the repo in your folder path `git clone https://github.com/aruppi/aruppi-api`.
Here are the steps to get started with the project on both platforms, use the corresponding commands if **npm** or **yarn**.
---
### **Installation**
In order to install the project and all dependencies, enter in the project folder and run `npm install`
or you can do the same with yarn with `yarn` in the project
In order to install the project and all dependencies, enter in the project folder and run `npm install` or you can do the same with yarn with `yarn` in the project
---
### Start the project
```bash
npm start
```
or
```bash
yarn start
```
@ -74,9 +60,6 @@ yarn start
```bash
npm build
```
or
```bash
yarn build
```
@ -91,47 +74,18 @@ npm test
yarn test
```
---
## Deprecated v1 for API
Aruppi has grown since it was launched and we need to continue improving the application along with the services to be able to give new features.
But if you need to see the code or the operation of the old version you can do it
- [Aruppi API GitHub (v1) [Deprecated]](https://github.com/aruppi/aruppi-api-v1)
- [Aruppi API Custom Link(v1) [Deprecated]](https://aruppi.herokuapp.com/api/Aruppi/)
## Countdown to deprecation of v2 API
Aruppi has grown since it was launched and we need to continue improving the application along with the services to be able to give new features.
At this time version 2.6.9 will remain functional until Aruppi App users fully migrate to version 1.5.0 of the app
## **:handshake: Contributing**
- Fork it!
- Create your feature branch: `git checkout -b my-new-feature`
- Commit your changes: `git commit -am 'Add some feature'`
- Push to the branch: `git push origin my-new-feature`
- [Jéluchu](https://github.com/Jeluchu) (Android Developer, designer, and others)
- [Capitanwesler](https://github.com/capitanwesler) (Backend developer, web developer and others)
**Documentation coming soon** at the following link: [**Aruppi Wiki**](https://github.com/aruppi/aruppi-api/wiki)
Where we will show more information about the calls and queries together with the response obtained or the different types of variables in some of the queries.
---
## Countdown to deprecation of v3 API
### **:heart: Show your support**
Aruppi API version 3.x.x has been deprecated, that's why all of you who are using it should migrate as soon as possible to version 4.x.x which we have already released.
Please :star: this repository if you like it or this project helped you!\
Feel free to open issues or submit pull-requests to help me improving my work.
Otherwise, if you want to use older versions you can host them yourself on your servers, and download the code in the corresponding branches of [**v2.x.x**](https://github.com/aruppi/aruppi-api/tree/v2) and [**v3.x.x**](https://github.com/aruppi/aruppi-api/tree/v3). In case you want to use an even lower version of the API we recommend you to have a look at this other version [**v1.x.x**](https://github.com/aruppi/aruppi-api-v1)
---
Currently the Aruppi app on Android is already using the v4.x.x API services from version v2.0.8, which you can download from our website: [**Download Aruppi App**](https://aruppi.jeluchu.com/download)
### **📚 Projects that use the API**
@ -148,7 +102,7 @@ Feel free to open issues or submit pull-requests to help me improving my work.
<tdalign="center"><ahref="https://github.com/Darkangeel-hd"><imgsrc="https://i.pinimg.com/564x/24/73/c0/2473c02e2ac93f617a28b2b5058bb41d.jpg"width="100px;"alt=""/><br/><sub><b>Darkangeel-hd</b></sub></a><br/><ahref="https://i.pinimg.com/originals/19/41/22/1941222eaee4de7d08dc21cc3993e791.jpg"title="Let's All Love lain!">👀</a></td>
</tr>
</table>
There are also **people who have made contributions** and therefore it is also important to highlight them.
Jéluchu
4 years ago
