Event Harbor

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 🙏 Attribution
• ❓ FAQ
• 📝 License

📖 [Event Harbor]

Event Harbor is a dynamic Full Stack event management web application, showcasing a sophisticated front-end developed using React. Users can effortlessly add, update, and delete events through an intuitive and responsive interface. The project is intricately designed with TailwindUI and Tailwind CSS, ensuring a visually appealing and modern user experience.

Behind the scenes, the back-end API powers the application, built with Ruby on Rails and supported by a PostgreSQL database. The API, residing in a separate repository, seamlessly integrates with the React front end, offering a comprehensive solution for managing events.

As an ongoing project, Event Harbor is committed to delivering a seamless and feature-rich event management experience. Stay tuned for updates and improvements as we continue to refine both the React front end and the Ruby on Rails API.

🛠 Built With

Tech Stack

• Framework: Ruby on Rails
• Programming Language: Ruby
• Database: PostgreSQL (PSQL)
• Testing Frameworks:
  • RSpec-Rails
  • Capybara-Rails
• CSS Bundling: Rails CSS Bundler
• Authorization: Cancan
• Authentication: Devise
• Database Adapter: Ruby Pg
• Code Quality: Rubocop
• Browser Automation: Selenium Webdriver
• Front-end: React
• Front-end Styling: TailwindCSS

Key Features

1. Data Model: A robust data model ensuring efficient storage and retrieval of event-related information.

2. Validations: Comprehensive data validations to maintain data integrity and consistency.

3. Model Spec-Tests: Rigorous specification tests for models to ensure they meet the defined requirements.

4. Controller Specs: Well-documented and tested controllers to guarantee proper handling of requests and responses.

5. Create Event: Seamless functionality allowing users to create new events with ease.

6. Update Event: User-friendly interface for updating event details, ensuring accurate and up-to-date information.

7. Delete Event: Secure and straightforward deletion of events as needed.

8. View Events: Intuitive views enabling users to easily navigate and explore the list of available events.

React Features

• Front-end Framework: Utilizing React for building a dynamic and responsive user interface.

• Component-Based Architecture: Leveraging React's component-based structure for modular and maintainable code.

• State Management: Implementing state management to efficiently handle and update the application's state.

• React Router: Enabling seamless navigation and a single-page application experience with React Router.

• Hooks: Utilizing React Hooks for functional components, ensuring the efficient management of state and side effects.

• Reusable Components: Developing reusable components to promote code reusability and maintainability.

• Responsive Design: Implementing responsive design principles for a consistent and user-friendly experience across devices.

(back to top)

🚀 Live Demo

Live Demo:

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/RileyManda/event-harbor.git

Install

Install this project with:

```sh
cd my-project
bundle install
```
```sh

Usage

To run the project, you will need to execute:

  ./bin/dev

Run tests

To run tests, run the following command:

  Rspec spec  or bundle exec rspec spec

(back to top)

👥 Authors

👤 RileyManda

• GitHub: @RileyManda
• Twitter: @rilecodez
• LinkedIn: rileymanda

(back to top)

🔭 Future Features

Deploy application to Render Video Presentation> Deploy Application Application styling

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support 🌟

Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:

• Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

• Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

• Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)

🙏 Acknowledgments

I would like to express my sincere gratitude to Microverse, for introducing me to Ruby and Ruby on Rails.

(back to top)

❓ FAQ

• Question_1

  Do I have to use the vs code specifically?

  • Answer_1

    You can use any code editor of your choice.
    

(back to top)

👥 Attribution

• ProjectIcon: Svgrepo

📝 License

MIT License

(back to top)