https://github.com/maximilianheidenreich/snipp-api
Backend API server for the Snipp frontend.
https://github.com/maximilianheidenreich/snipp-api
pastebin pastebin-api pastebin-service
Last synced: 3 months ago
JSON representation
Backend API server for the Snipp frontend.
- Host: GitHub
- URL: https://github.com/maximilianheidenreich/snipp-api
- Owner: MaximilianHeidenreich
- License: gpl-3.0
- Created: 2020-10-25T13:09:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-04T09:50:51.000Z (over 5 years ago)
- Last Synced: 2025-03-12T11:49:07.874Z (over 1 year ago)
- Topics: pastebin, pastebin-api, pastebin-service
- Language: JavaScript
- Homepage: https://snipp.xyz
- Size: 69.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPLv3 License][license-shield]][license-url]
Snipp API
A simple API server for the Snipp frontend.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## About The Project
**! If you want to know more about Snipp, please continue reading inside the main project: [Snipp](https://github.com/MaximilianHeidenreich/Snipp)**
Snipp API provides a small API server for the Snipp frontend using express. The API server bridges the gap between the frontend and a PostgreSQL database which stores Snipp's data.
The server is pretty basic, only implementing a few routes to fetch & update data, but also exposes an API documentation / testing route using [Swagger UI](https://swagger.io/tools/swagger-ui/).
It can beasily be deployed to a standalone server or [Heroku](https://heroku.com/).
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install npm@latest -g
```
### Installation
1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo
```sh
git clone https://github.com/your_username_/Project-Name.git
```
3. Install NPM packages
```sh
npm install
```
4. Enter your API in `config.js`
```JS
const API_KEY = 'ENTER YOUR API';
```
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
## Roadmap
See the [open issues](https://github.com/MaximilianHeidenreich/Snipp-api/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the GNU GPLv3 License. See `LICENSE` for more information.
## Contact
Maximilian Heidenreich - github@maximilian-heidenreich.de
Project Link: [https://github.com/MaximilianHeidenreich/Snipp-api](https://github.com/MaximilianHeidenreich/Snipp-api)
[contributors-shield]: https://img.shields.io/github/contributors/MaximilianHeidenreich/Snipp-api.svg?style=flat-square
[contributors-url]: https://github.com/MaximilianHeidenreich/Snipp-api/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/MaximilianHeidenreich/Snipp-api?style=flat-square
[forks-url]: https://github.com/MaximilianHeidenreich/Snipp-api/network
[stars-shield]: https://img.shields.io/github/stars/MaximilianHeidenreich/Snipp-api?style=flat-square
[stars-url]: https://github.com/MaximilianHeidenreich/Snipp-api/stargazers
[issues-shield]: https://img.shields.io/github/issues/MaximilianHeidenreich/Snipp-api?style=flat-square
[issues-url]: https://github.com/MaximilianHeidenreich/Snipp-api/issues
[license-shield]: https://img.shields.io/github/license/MaximilianHeidenreich/Snipp-api?style=flat-square
[license-url]: https://github.com/MaximilianHeidenreich/Snipp-api/blob/master/LICENSE.md
[product-screenshot]: images/screenshot.png