jaferIdrees/officeverse-api

Capstone project

Officeverse

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• Kanban Board

• 🤝 Contributing
• ⭐️ Show your support

• 📝 License

📖 [Officeverse]

Your Next Office outside the Office.

[Officeverse] Individuals, small and big teams gain access to space that is both more customized than coffee shops and cheaper than full leases, and coworking businesses get to rent out their unused office space and foster a community of growth and innovation.

🛠 Built With

Tech Stack

This a Rails Api with endpoints for all the models we use in the Front-end. Each model have validations for data integtity.

Front-End Repository

Client

• React.js
• Redux
• Redux Toolkit
• Javascript

Server

• Ruby On Rails

Database

• PostgreSQL

Key Features

Our API have great feautures.

• Login, SignUp, Logout Endopoints
• Current User Endpoint
• JWT Token Authentication

(back to top)

💻 Getting Started

Please Fork or Clone this repo.

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

Prerequisites

In order to run this project you need: Ruby.

 ruby -v

If you get something like this ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21], you have ruby installed. Otherwise follow this tutorial to install it.

Ruby On Rails.

 rails -v

If you get something like this Rails 7.0.4, you have rails installed. Otherwise type:

 gem install rails

PostgreSQL.

 psql --version

If you get something like this psql (PostgreSQL) 14.6, you have postgreSQL installed. Otherwise follow this tutorial to install it.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git https://github.com/Fourteen98/officeverse-api.git

Install Gems

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, execute the following command:

  rails server

Your server will run on http://127.0.0.1:4000

Run tests

To run tests, run the following command:

  bin/rails rspec spec

👥 Authors

This is the awesome team (4 members) that built this project.

👤 Raul A Ospina 🧑🏻‍💻

• GitHub: @raminka13
• Twitter: @raminka13
• LinkedIn: Raul Ospina

👤 Muhyideen Elias

• GitHub: @fourteen98
• Twitter: @muhyideen
• LinkedIn: Muhyideen Elias

👤 Ja'fer Yousef

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: jaferll

👤 Diego Yon

• GitHub: @diegoyon
• Twitter: @diegoyon
• LinkedIn: Diego Yon

(back to top)

Kanban Board

Initial Kanban Board

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...give us a ⭐️.

(back to top)

📝 License

This project is MIT licensed.

(back to top)