Welcome to Meet&Eat, the best place to find friends, food and fun.
✅ Users can sign up and sign in to Meet&Eat
✅ Users can upload an avatar
✅ Users can post a lunch spot with a date, time, location and description
✅ Users can only edit or delete their own lunch spots
✅ Lunch spots appear on a map with the location marked
✅ Users can see all posted lunch spots on the homepage
✅ Users have a profile that displays the lunch spots they've posted
✅ Users are automatically an attendee of a lunch spot they post
✅ Users can join a lunch spot they'd like to attend
✅ Users can leave create, edit and delete comments on a lunch spot
✅ Users can choose a dietary preference (ex. vegetarian, pescitarian)
✅ Users can change their dietary preference
✅ Expired lunch spots are not listed
✅ Users can filter lunch spots by time and date
✅ Users can filter lunch spots by location
✅ All active lunch spots display on a map
✅ All active lunch spots an active date
✅ Users can assign themselves interest tags (ex. coding, illustration)
✅ Spots can be sorted by past, present and future
✅ When typing in location, autofill activates to suggest places
Heroku application: https://meet-andeat.herokuapp.com/
Trello board: https://trello.com/b/P43rsW5t/meateat-planning
- Git fork and clone the repository and cd into the Meet-and-Eat folder
- Run
bundle install - Run
rake db:setup - Run
bundle exec figaro installwhich will create an application.yml file and this file will be automatically .gitignored. - Add your own google maps api key or ask a member of the team to supply you with the dev version by pasting
google_maps_api_key: xxxwhere the x’s will be replaced by an existing key - Run
rails swhich will boot up the server on localhost:3000 which you will need to type into a browser address bar - Sign up as a new user and add spots as necessary. Get your friends to join and test the app by going for lunch together! Have fun :)
Testing Instructions
bundle exec rspec # Run the tests to ensure it works
bin/rails server # Start the server at localhost:3000
As a luncher,
So I can show where I am going,
I would like to be able to add a lunch spot
As a luncher,
So other users can meet up with me,
I would like to show my spot on a main board
As a luncher,
So I can join others at a spot,
I would like to be able to join a spot
As a luncher,
So I can show people my dietary restrictions,
I would like to be able to set my dietary preference upon sign up
As a luncher,
So I can easily view where everyone is going,
I would like all lunch spots to appear on a single map
As a luncher,
So I can customise my profile,
I would like to be able to edit my avatar and dietary preference on the edit user page
As a luncher,
So I can let people know I am attending a spot,
I would like to be able to comment on other lunch spots made by users
As a luncher,
So I know what restrictions other people have,
I would like to be able to see their dietary preference upon joining a spot
As a luncher,
So I can easily enter a spot location,
I would like for it to be able to autofill upon typing
If you wish to contribute to the project then please do so by running the code through the rspec tests and the rubocop linter.
We are open to pull requests and would definitely appreciate any comments and feedback that you may have about the project.
Please ensure that the pull request is descriptive and easy to understand so as to minimise the time between the request and merge.
Please follow the instructions set below:
- Create an account on Heroku
- Install the Heroku command line tools by running the following from the command line
brew install heroku/brew/heroku - Create the heroku application, either on Heroku(https://id.heroku.com/login) or running the following from the command line
heroku create app-name - Push the app to Heroku via the command line using
git push heroku master - Create the app database on Heroku via the command line using
heroku run rake db:migrate - Open the app on Heroku via the command line using
heroku open - You may need to login via the Heroku command line interface (CLI) at any point:
heroku login - On the Heroku website, go to your app console and take a look at the deploy options.
From there, you can connect to GitHub via the Heroku integration. Select the option to automatically deploy the app to Heroku only when the CI build passes.
Below are some diagrams which we drew up in the initial stages of the application during our daily standup. It helped us to create a basic outline of the project and we used it as a guide to get us up and running.
Furthermore we had created a wiki page to help us document our work (link found below) which would in the show how much we had learned and accomplished throughout the project.
Wiki pages: https://github.com/AsadK47/Meet-and-Eat/wiki
Diagram of MVP
Diagram of the iterations in development
