Table of Contents
-
About The Project
-
Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgments
About The Project
(back to top)
Built With
(back to top)
Getting Started
Hello and welcome to the rster project. Rster is the easiest way to build your backend api in nodejs. It is a framework that allows you to build your api in a modular way. Just define your library then use your functions to access and modify your data. Or directly add it to the express app using express.use()
. It is up to you. You can even generate a typescript client directly from your server-side api definition!
Prerequisites
-
npm
npm install npm@latest -g
alternatively you can use yarn
npm install yarn@latest -g
Installation
-
Install the package
npm install rster
using yarn
yarn add rster
-
Import the package
import rster from "rster";
(back to top)
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
(back to top)
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
- 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
(back to top)
License
Distributed under the BSD-3-Clause License. See LICENSE
for more information.
(back to top)
Contact
Nicolas Schmidt
Project Link: https://github.com/nsc-de/rster
(back to top)