Love Notes

Express your feeling to everyone or someone your care.

Heroku Live Demo | Digital Ocean Live Demo

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Unit Testing
  • Prerequisites
  • Installation
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This is capstone project of Microverse Rails Curriculum.Project Name is Love Notes. Love Notes is online note to share everyone or someone you care. User note will be hosted online as note and Other user can view and vote love.

• Create Note via Form
• Show Note in Home Page
• Can click Love Button your loved
• Login with Username
• User Profile Page
• Show other Profile Page

Built With

For the whole project, I used following tools and language.

• Ruby
• Rails
• Jquery
• Rspec
• Html,CSS

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• ruby

https://www.ruby-lang.org/en/downloads/

Installation

1. Clone the repo

git clone git@github.com:konyan/love-note.git
cd project

2. Check your Ruby version

ruby -v

The ouput should start with something like ruby 2.5.1

3. Install dependencies

Using Bundler and Yarn:

bundle && yarn

4. Initialize the database

rails db:create db:migrate db:seed

5. Add heroku remotes

Using Heroku CLI:

heroku git:remote -a project
heroku git:remote --remote heroku-staging -a project-staging

6. Serve

rails s

7. Deploy

With Heroku pipeline (recommended)

Push to Heroku staging remote:

git push heroku-staging

Go to the Heroku Dashboard and promote the app to production or use Heroku CLI:

heroku pipelines:promote -a project-staging

Unit Testing

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• ruby

gem install rspec

Installation

1. Run spec files at Spec Folder

rspec spec/job_spec.rb
rspec spec/joburl_spec.rb
rspec spec/position_spec.rb

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

WTF LICENSE. You can do whatever you want, I don't care. :P

Contact

@devkonyan - devkonyan@gmail.com

Acknowledgements

• Rails Docs Guide