Freedemy API

This is the version 2 of the REST API for the Freedemy React client
Explore the docs »

View Demo · 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

This is version 2 of the final project of the Ironhack Madrid web development bootcamp. Developed from scratch a year later with the idea of applying what we learned and deepen in new concepts.

You could check the documentation to find the endpoint list and options:

Documentation (Work in progress)

(back to top)

Built With

• Node.js
• Express.js
• MongoDB
• JWT

(back to top)

Getting Started

Prerequisites

You will need Node 16+ installed and MongoDB cluster set and ready. This project is prepared to handle a development DDBB and a production DDBB. Be careful with GitHub actions pipeline, you may need to delete it or adjust the configuration to your needs.

Installation

1. Clone the repo

   git clone https://github.com/Joseacasado/freedemy-backend.git

2. Install NPM packages

   npm install

3. Create .env file and set the following variables

   PORT, PORT_DEV, DB_REMOTE_DEV, DB_REMOTE_PROD, DOMAIN_LOCAL, DOMAIN_REMOTE, AUTH_JWT_SECRET, AUTH_JWT_EXPIRES_IN, AUTH_JWT_EXPIRES_IN_REMEMBER, HASS_KEY

(back to top)

Usage

To find the available scripts, open your terminal and run

npm run

To run the development server run:

npm run dev

To run the production server run:

npm run start

To run eslint run:

npm run lint

(back to top)

Roadmap

• Config and add Swagger
• Set ECMASCRIPT Modules
• Add endpoints
  • Auth
  • User
  • Teacher
  • Course
  • Comment
  • File

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

(back to top)

Contact

Jose A. Casado - LinkedIn profile Marisa Vitale - LinkedIn profile

Project Link: https://github.com/Joseacasado/freedemy-backend

(back to top)

Acknowledgments

• README template

(back to top)