Tweeter - Totally Not Twitter

Description Sample
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Future Scope
6. Contributing
7. License

About The Project

The app itself will feature a basic

Create Read Update and Destroy Tweets.

On top of the Tweets, I introduce a new gem called Devise which makes creating an entire user role and authentication system easy. Combined with this gem we can authenticate users who want to author tweets. A user's Tweets are then also tied to their account. The end result is a public facing site with a stream of tweets from different users. Users that have and account can login to create their own tweets to add to the public stream.

Built With

• Ruby-on-Rails

Ruby gems used in this build

• Better Errors - For better errors

• Bulma - for easy CSS. Feel free to roll your own styles and/or use a different framework.

• Guard - Useful for live reloading our scss, js, css, and erb files, although it's capable of much more!

  Guard is required for the Guard LiveReload gem to work

• Guard LiveReload

• Simple Form - For simple forms!

• Devise - Effortless user roles and authentication

• Gravatar_image_tag - Integrated image tag which spits out gravatars.

Getting Started

Prerequisites

• Ruby
• Rails
• Bundler
• SQLite3
• NodeJS

Installation

1. Clone the repo

   git clone https://github.com/kanitmann/tweeter.git

2. Install Rails

   gem install rails

3. Install required gems

   bundle install

4. Install yarn

   npm install yarn

5. Install Bundler

   gem install bundler

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Future Scope

My future plans are to make this web app decentalized using etherium.rb so it does not depend on a centralized server to be working.

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

Distributed under the GPL3.0 License. See LICENSE for more information.

Made with 💙 by Kanit Mann