uno36/eventSchedulerAPI

The EventSchedulerAPI is a RESTful Rails application enabling users to manage events. It employs Devise with JWT for user authentication, offering CRUD operations for creating, viewing, updating, and deleting events. With secured endpoints, it facilitates event scheduling and organization in a user-friendly manner.

📗 Table of Contents

• 📗 Table of Contents
• EventScheduerAPI
  • 🛠 Built With
    • Tech Stack
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • ❓ FAQ (OPTIONAL)
  • 📝 License

EventScheduerAPI

• The EventSchedulerAPI is a RESTful Rails application enabling users to manage events. It employs Devise with JWT for user authentication, offering CRUD operations for creating, viewing, updating, and deleting events. With secured endpoints, it facilitates event scheduling and organization in a user-friendly manner.

🛠 Built With

Tech Stack

Client

• React

Server

• Ruby on Rails

Database

• PostgreSQL

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  git clone https://github.com/uno36/event-scheduler-back-end.git
  cd event_scheduler_app  

Install

Install this project by executing the following commands. Since its an Open API, there is no need to set up any API keys:

  cd event_scheduler_app

  bundle install

  touch .env
    `Add the following lines to the .env file`
      DB_USERNAME=`Your PostgreSQL username`
      DB_PASSWORD=`Your PostgreSQL password`

  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

👥 Authors

👤 Emmanuel Tofa

• GitHub: @uno36
• LinkedIn: LinkedIn

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project consider leaving a star to the repository.

(back to top)

❓ FAQ (OPTIONAL)

What is an event scheduler

• An event scheduler is a digital tool enabling seamless organization, tracking, and management of various engagements. It empowers users to create, update, and delete events, specifying titles, descriptions, dates, and times. Integrated with user authentication, it ensures secure access and modification of events, allowing individuals or teams to efficiently plan meetings, presentations, or social gatherings. Through a user-friendly interface, it provides a centralized hub for scheduling, streamlining daily routines, and ensuring timely execution of tasks while fostering collaboration and better time management among participants.

(back to top)

📝 License

This project is MIT licensed.

(back to top)