Flossophy Rest API

🪶RESTAPI for Flossophy using Koa.js and MongoDB.
Explore the docs (!WIP!) »

View Demo (!WIP!) · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• 
• 
• 

Also uses:

• Nodemailer
• Argon2
• Jsonwebtoken

(back to top)

Getting Started

Following the guide with steps listed below will help you run this application.

Prerequisites

• Node.js Latest Version
• MongoDB Locally hosted or Atlas (please look elsewhere for details on how to install them.)

Installation

1. Clone the repo

   git clone https://github.com/lat0s/FlossophyREST.git

2. Navigate to /app directory, open a new terminal and write the following command

   npm install

3. Create a new empty file named .env

4. Enter the following in .env

   SMTP_SERVICE=<YOUR_SERVICE>
   SMTP_USER=<YOUR_EMAIL>
   SMTP_PASS=<YOUR_PASS>
   EMAIL_FROM=<YOUR_EMAIL>
   MONGODB_URI=<YOUR_MONGODB_URI>";

5. Look here for more information. I personally used Gmail and followed the instructions on the link. If u follow the guide then the password in SMPT_PASS should be the one u copied from the App Password. The SMTP_USER should be the Gmail address and the SMTP_SERVICE=gmail.

6. Run the application

   node app.js

(back to top)

Usage

This REST API is intented for usage within the Flossophy Full-Stack Project (!WIP!).

(back to top)

Roadmap

• N/A

See the open issues for a full list of proposed features (and known issues).

(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 Apache 2.0 License. See LICENSE.txt for more information.

(back to top)

Contact

X - @lat0ss Discord - @lesbiathan

Project Link: https://github.com/lat0s/FlossophyREST

(back to top)

---