Inspiration

The project was a prompt from Winhacks 2021 solo participation, and to be honest this was my first hackathon alone.

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 an account can log in to create their own Tweets to add to the public stream.

Built With

Challenges we ran into

Lots of ruby dependencies are unstable on Windows and hence gave lots of issues. Even gem: Guard is fairly unstable.

Accomplishments that we're proud of

I am proud to have it finished within the hackathon time and that too with all functionalisties

What I learned

I learned Ruby-on-Rails from scratch. Also, it helped me polish my existing knowledge about HTML, CSS, and JS.

Future Scope

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

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

Getting Started

Prerequisites

  • Ruby
  • Rails
  • Bundler
  • SQLite3
  • NodeJS

Installation

  1. Clone the repo bash git clone https://github.com/kanitmann/tweeter.git
  2. Install Rails bash gem install rails
  3. Install required gems bash bundle install
  4. Install yarn bash npm install yarn
  5. Install Bundler bash gem install bundler

Roadmap

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

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

Built With

+ 46 more
Share this project:

Updates