A simple API server for the Snipp frontend.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
! If you want to know more about Snipp, please continue reading inside the main project: 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.
It can beasily be deployed to a standalone server or Heroku.
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.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/your_username_/Project-Name.git- Install NPM packages
npm install- Enter your API in
config.js
const API_KEY = 'ENTER YOUR API';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
See the open issues for a list of proposed features (and known issues).
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the GNU GPLv3 License. See LICENSE for more information.
Maximilian Heidenreich - github@maximilian-heidenreich.de
Project Link: https://github.com/MaximilianHeidenreich/Snipp-api