/al-mentoria-backend

Al-Mentoria is a place for new programmers to reserve a meeting with some more experienced programmer as their mentor based on a chosen topic. We built the backend using Rails and the front using React/Redux.

Primary LanguageRubyGNU Affero General Public License v3.0AGPL-3.0

Microverse AGPL Licensed GitHub last commit (branch) GitHub Repo stars GitHub followers

Logo


Explore the API docs »

View Demo · Report Bug · Request Feature

TABLE OF CONTENTS
  1. About The Project
  2. Getting Started
  3. Usage
  4. Kanban board
  5. Contributing
  6. Authors
  7. Acknowledgments
  8. License

About The Project

Al Mentoria is a virtual space to connect with mentors that can help you with your technical as well as behavioral issues. If you are stuck somewhere and need a second look at things, make a reservation now.

ERD diagram

ERD diagram

Built With



Getting Started

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

Prerequisites

  • POSTGRESQL ~> 14.x
  • Ruby ~> 3.1.x

Installation

  1. Clone the repo:

    git clone git@github.com:UpliftLab/al-mentoria-backend.git

  2. go to the project folder:

    cd al-mentoria-backend

  3. Install the dependencies:

    bundle install

  4. Set the following the environment variables for database:

    PG_DB_USERNAME
PG_DB_PASSWORD

  5. Create database:

    rails db:create

  6. Run the migrations:

    rails db:migrate

  7. Seed the database:

    rails db:seed

  8. Launch the server:

    rails s -p 8000

  9. Enjoy

⬆️

Usage

For more Info on how to use the API, please refer to the al mentoria API Documentation

Kanban board

👉 Kanban board link

Initial State Final State
drawing drawing

👉 This project was authored by Four contributors as described in the the Authors section bellow.

👉 Please use this link to go to the front-end part of this project.

⬆️

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.

Please, take a look at open issues for a full list of proposed features (and known issues).

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

⬆️

Authors

👤 Soufiane Boursen

👤 Ammar Hamlaoui

👤 Mostafa Ahangarha

👤 Awais Amjed

⬆️

Acknowledgments

⬆️

License

Distributed under the AGPL License. See LICENSE for more information.

⬆️