CzerwoniakPlus API

🌊 A fresh look on original CzerwoniakPlus's API, using TypeScript and ExpressJS

Open CzerwoniakPlus in browser · Report a bug · Request a feature

Table of Contents

1. About the project
   • Built with
2. Getting started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

This repository contains the newest version on CzerwoniakPlus's API. It is a completly fresh look on what we have done with the old (private and archived) one. We are more than happy to accept any feedback from you!

(back to top)

Built with

• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure to use Node.js version of at least v16.15.0 and install newest versions of:

• npm

  npm install npm@latest -g

• yarn

  npm install yarn@latest -g

Installation

1. Clone the repo

   git clone https://github.com/CzerwoniakPlus/CzerwoniakPlus.git

2. Install required packages

   yarn install

3. Copy .env.example file and rename it as .env. Replace values with necessary data

   firebase_db_url = FIREBASE_DB_URL_HERE
   auth_secret = SECRET_PHRASE_TO_AUTHORIZE_POST_REQUESTS

4. Create a config directory in the root of project.
   • Make two subdirectories named: firebase and keys
5. Generate and put your key and certificate PEMs in keys directory
6. Generate and put your serviceAccount.json in firebase directory

(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!

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

(back to top)

License

Distributed under the BSD-3-Clause license. See LICENSE for more information.

(back to top)

Contact

Mateusz Tatko - @mtatko - [email protected]

Project Link: https://github.com/CzerwoniakPlus/api

(back to top)