An open API service indexing awesome lists of open source software.

https://github.com/teekaytech/mini-twitter


https://github.com/teekaytech/mini-twitter

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          

# Mini Twitter

The aim of this project is to implement rails devise gem. In this project, I cloned the basic features of Twitter, with emphasis on understanding the functionalities of devise gem.

## Built with
* Ruby on Rails
* Devise gem
* SqLite (Development)
* PostgreSQL (Production)
* Bulma Framework
* Heroku

## Getting Started

To get a local copy up and running follow these simple steps.

- On the project GitHub page, navigate to the main page of the repository [this page](https://github.com/teekaytech/Mini-Twitter.git).
- Under the repository name, locate and click on a green button named 'Clone or download'.
- Copy the project URL as displayed.
- If you're running Windows Operating System, open your command prompt. On Linux, Open your terminal.
- Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.
- Type `git clone`, and then paste the URL you copied in Step 3.

`$ git clone https://github.com/teekaytech/Mini-Twitter.git`
- Press Enter. Your local copy will be created.

Please Note that you must have github installed on your PC, this can be done [here](https://gist.github.com/derhuerst/1b15ff4652a867391f03).

### Prerequisites

Since all the code is written using ruby on rails, `Ruby Runtime >= 1.9` and `rails 6` is required to interpret the code. If you don't have ruby on rails runtime already setup on your computer, follow the instruction for your specific operating system on the [official installation guide](https://guides.rubyonrails.org/getting_started.html#creating-a-new-rails-project-installing-rails).

## Live demo
[Live Demo Link](https://morning-lake-55391.herokuapp.com/)

### Usage (Locally)

After cloning on your computer, open the folder using your terminal/command prompt window and run:

`bundle install`

`rails db:migrate`

`rails server`
to checkout the application

## Author

👤 **Taofeek Olalere**

- Github: [@teekaytech](https://github.com/teekaytech)
- Twitter: [@ola_lere](https://twitter.com/ola_lere)
- Linkedin: [linkedin](https://linkedin.com/in/olaleretaofeek)

## 🤝 Contributing
Contributions, issues and feature requests are welcome!
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.

Feel free to check the [issues page](issues/).

## Show your support

Give a ⭐️ if you like this project.

## 📝 License

This project is [MIT](lic.url) licensed.

## Acknowledgements

- [The Odin Project](https://www.theodinproject.com/courses/ruby-on-rails/lessons/forms)
- [Web-Crunch](https://www.youtube.com/watch?time_continue=1&v=5gUysPm64a4&feature=emb_logo)