Skip to content

An app to publish and create a user-customized calendar of events to follow in my hometown, Morelia.

Notifications You must be signed in to change notification settings

oscarnava/Events-calendar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📅 Events calendar

This project consists of an app to publish a calendar of events to follow in my hometown, Morelia, in the state of Michoacán, México.

The events are listed by date, and if the user signs/logs in, the system will keep record of the events added to the user's schedule, and the user will be able to rate the event.

🛠 Built with:

  • Ruby / Rails
  • Javascript / React / Redux
  • Lots of coffee! ☕☕☕

👀 Live demo:

⚙ Getting Started

Prerequisites

  • Ruby: Check this link if you need to install it
  • Rails: Check this link if you need to install it
  • Node.js: Check this link if you need to install it
  • PostgreSQL: Check this link if you need to install it

Setup

Important note : Since the big aim of this project was to showcase the use of an API to implement communication between a web application's backend and frontend, both these parts are independent applications in the sense that they can reside in different servers.

So, having said that, be aware that by installing the backend you are NOT automatically enabling the frontend; you can install them in one single server, or two different servers, but they must be both installed independently. Notice how, for example, the Live demo frontend is served from GitHub pages and the backend from Heroku.

Apart from the API requests, one application knows nothing about the other.

You can start by cloning this repository in your local storage. You will notice there are two folders named backend and frontend. Please refer to the specific README inside each folder for further instructions on setting it up.

Deployment

Since this is a rather unusual way of organizing a repository, please check this article on Deploying Rails API and React App to Heroku from a single GitHub repo, or if you prefer you can just split the subfolders out into a new repository.

Again, please refer to the specific README inside each folder for further instructions.

👤 Author

Oscar Nava Trujillo

⌛ To-do's

Backend
  • Admin panel to create, update and remove events

  • Important! User email validation. (I'm sick of receiving unwanted emails from unverified services; I don't want others to suffer this because of me)

Frontend
  • Possibility to filter the events list to show only the logged user scheduled events
  • Prevent rating the event before it takes place
  • Display a divider between events for different days, to aid the user on locating the day's event

📦 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

💬 Credits

Design idea by Ibrahim Shaqura on Behance

🗝 License

Creative Commons Attribution 4.0 International (CC BY 4.0)

📡 Contact

Please don't hesitate to contact me at 📧 contact@oscarnava.me if you have any questions, comments, etc. I would love to know what's on your mind!

About

An app to publish and create a user-customized calendar of events to follow in my hometown, Morelia.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages