https://github.com/graviton-code-editor/store-api
💫 Graviton Store API
https://github.com/graviton-code-editor/store-api
api eslint express-js graviton hacktoberfest javascript js node
Last synced: 3 months ago
JSON representation
💫 Graviton Store API
- Host: GitHub
- URL: https://github.com/graviton-code-editor/store-api
- Owner: Graviton-Code-Editor
- License: mit
- Created: 2020-03-30T09:41:30.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-11T11:33:01.000Z (over 2 years ago)
- Last Synced: 2025-04-10T05:31:33.874Z (3 months ago)
- Topics: api, eslint, express-js, graviton, hacktoberfest, javascript, js, node
- Language: JavaScript
- Homepage: https://graviton-api.herokuapp.com
- Size: 623 KB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# 🎡 Graviton Store's API
Hosted in https://graviton-api.herokuapp.com/
## 📖 Usage:
| Method | Endpoint | Description |
| ------------- | ------------- | ----- |
| GET | / | Get API information |
| GET | /plugins/ | Get the whole list of plugin ids |
| GET | /plugins/:pluginID | Get plugin info by it's id |
## 🛠️ Development
1. Install all the dependencies
```sh
$ npm install
```
2. Start the project in dev mode. This command will start a development server.
```sh
$ npm run dev
```
## 🔌 Publishing Plugins
1. Fork this repository.
2. `git clone https://github.com//store-api.git`
3. `cd data`
4. `mkdir `
5. `cd `
6. Create a file called `manifest.yaml`.
7. In `manifest.yaml` put the following:
```yaml
name:
id:
author:
description:
repository:
releases:
- version:
minTarget:
target:
url:
```
##### About the yaml information above
* `id, repository, url`: __cannot__ contain whitespace
* `releases` is an array, so you can have multiple releases
* To create a release for your plugin:
1. On your plugin's repository homepage, create a release and upload a `.zip` folder with only functional files for the plugin
2. Once the release is published, copy the download-url, and release version of the release and paste into the `url`, `version` fields above respectively.
* `minTarget` will be the minimum version of Graviton(`X.X.X`)
* `target` will be a more specific target, you can for example use `2` to target Graviton v2.X.X, or `2.1` for v2.1.X
8. Commit changes and create PR
## 🎎 Contributing
#### Before commiting on git
* Get all your linting error (with ESlint)
```sh
$ npm run lint
```
* Fix all your linting error automatically (with ESlint)
```sh
$ npm run lint:fix
```
## 🧦 Tests
To run the tests, run:
```shell
$ npm test
```
## 💾 Production
1. Install all the dependencies
```sh
$ npm install
```
2. Start the project in production mode.
```sh
$ npm run start
```
## Contributors 🤠
LucasAlt [Github](https://github.com/LucasCtrl)
David Niederweis [Github](https://github.com/DJN1)