Code Monkey home page Code Monkey logo

al-mentoria-backend's Introduction


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 [email protected]: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.

⬆️

al-mentoria-backend's People

Contributors

awais-amjed avatar mirouhml avatar ahangarha avatar sboursen avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.