Name of Project:

Twitter like application called Capter!

Table of contents:

1. About The Project
2. Built With
3. Getting Started With The Project
4. Contributing
5. License
6. Contact/Contributors i. Link To Project On Github
7. What Was Learnt During The Project
8. Acknowledgements

About The Project:

This project is all about building a web application that looks like the popular social media application called twitter. But i called it Capter. It has some basic functionality of the original twitter where a new user can sign up, an existing user can sign in and send a tweet or what i called a capt. A user can not see a conversation except if he or she signs in. A user can as well edit a conversation, edit it or have it deleted.

Built With:

Ruby On Rails, Bulma - a CSS framework.

Getting Started With The Project:

1. You need to have a computer with a good operating system

2. Any code editor can serve but i preferred using VSCode.

3. The will and determination to learn how to write codes.

4. Create a new rails project by using the command: 'rails new (the name of your would be app)'.

5. Add some gems like: gem 'better_errors', gem 'guard', gem 'guard-livereload', gem 'web-console', gem 'bulma-rails', gem 'devise', gem 'gravatar_image_tag', gem 'simple_form' from RubyGemsSite to get the latest version of the gem, 'save' and run 'bundle install' to install the gem.

6. Ensure you bring up your rails application using 'rails server' and run 'rails generate scaffold (and the model you want to use, in my case i used Capt capt:text)' and then ran the 'rails db:migrate' command later to get started with the project.

7. Install other necesary things that are needed for the project.

8. Add and commit your changes using your version control system known as git by running 'git init', then consolidate it with your consolidation system using either Github or Gitbucket, adding the remote repsitory you have created locally.

Contributing:

In this project, your contributions towards helping in improving this project would be well accomodated. With that, the project will get better rating and give programmers at any level the ability learn, be inspired and create better content.

After you are done with your contributions, you can:

i. Fork The project. ii. Create your feature branch using git checkout -b feature/anyfeature(for example) iii. Commit your changes following git commit -m 'Name it as it pleases you', when you are done, iv. Push to the branch you have created using git push origin feature/anyfeature and finally v. Open a pull request.

License:

Distributed under the MIT Licence. See Licence for more informaton.

Contributor(s):

Kingsley McSimon O.

Link To The Project On Github:

Project On Github

What Was Learnt During The Project:

I used this project to add to my knowledge of the Ruby On Rails web technology used in building this application.

Acknowledgements/References:

Web-Crunch video 1,

Web-Crunch video 2 and

Web-Crunch video 3 was very handy in putting this application together.