Visit The Site »
Download this repository
|
Report A Bug
|
Fork It
- The Project Brief
- The Nitty Gritty
- Tools & Technology Used
- Setup & Use
- Showcase
- Contributions, Issues and Forking
- Creator
- Show Your Support!
- Credit & Acknowledgements
- Licensing
This is the Ruby on Rails Capstone Project, to be completed by students of Microverse.
This project is unlike those that have come before it. We are required to adhere to the following guidelines:
- Mandatory technical specifications to reach
- A design brief to follow
- Presentation of the project once finished, providing a demo, project features, extra features and how we tackled the n+1 problem.
- 5 day build time for a Minimum Viable Product
The Capstone therefore demonstrates itself to be a more true-to-form application of our skills to real-world projects, providing us with valuable experience of creating deliverables under time pressure.
The project objective was to build a Ruby on Rails based web application that would group a chosen item together, for example, payments, projects between friends, or in the case of this project, activities.
The design guidelines followed that of Snapscan, designed by Gregoire Vella, however a certain amount of wiggle room beyond the colors, typographies and general layout was allowed.
Beyond the familiar groups, memberships and users features, this project focused on bringing some, albeit rudimentary, statistics to the user - a feature that is commonplace today in activity trackers.
Languages & Frameworks
- Ruby 2.7.1
- Ruby on Rails 6.0.3.1
- SASS/CSS3
- Bootstrap
Gems of note
- Devise
- Faker
- HIRB (GOAT Award 🥇)
- Bullet
- FontAwesome
Testing
Database
- PostgreSQL
Linters & Quality Control
Deployment
- Heroku
Follow this link to see a live version of the project. If you'd like a closer look, continue reading....
Setup should be fairly straightforward. You will have to ensure your machine is properly equipped to run the code first:
- Make sure you have both Ruby and Ruby on Rails (Mac • Linux • Windows) installed.
- Download this repository.
cdinto the root directory of wherever you download this repo. What does 'cd' mean?- Whilst at the root (home) directory of this project, enter
bundle installto install the projects software dependencies. - In your terminal window, enter
rails serverto start the server. - Now navigate to
localhost:3000in your browser to start playing around with the webpages!
Alternatively if you'd like to confirm the entire project is passing testing:
cdinto this repository in your terminal- Enter
bundle exec rspecto run all tests
Creating an activity will log it immediately, provide you with its statistics on the Activity Page and increment the weekly activity count on the users profile.
From the 'My Groups' page, the user can see all their active group memberships, as well as suggested groups not yet joined. Continuing to the 'Create Group' page allows the user to create a new group with a name, description and auto-populated group icon. A new group will appear site wide.
Navigating from the 'My Groups' page, the user can find new groups in the 'Suggested Groups' section. On the Group page itself, the user is presented with the option to join (or leave) the group, the current member list with KOMs and trophies and recent activities at the bottom.
Contributions, issues and feature requests are more than welcome!
If you have any problems running or setting this project up, please submit it as a bug on the issues page. right away!
If you want to make your own changes, modifications or improvements, go ahead and Fork it!
- Fork it
- Create your working branch (git checkout -b [choose-a-name])
- Commit your changes (git commit -am 'what this commit will fix/add/improve')
- Push to the branch (git push origin [chosen-name])
- Create a new Pull Request
Rory Hellier - Github
Give a ⭐️ if you like this project!
The original design specifications and influence for this project are drawn from Gregoire Vella's Snapscan design on Behance.
This project is MIT licensed.