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

https://github.com/cliftondavies/twitter

A lightweight version of Twitter.
https://github.com/cliftondavies/twitter

bulma css3 html5 ruby ruby-on-rails sqlite3

Last synced: 3 months ago
JSON representation

A lightweight version of Twitter.

Awesome Lists containing this project

README

          

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Open Source Love png1](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/)
![Tweeting](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)

# Twitter

> A minimalist Twitter clone with full user authentication, so users can only access areas of the site they are authorised to.

![screenshot](screenshot.png)

## Functionality

- User Account: Sign Up, Log in*, Update*, Delete*
- Tweet: Create*, Edit*, Delete*

## :toolbox: Tools & Technologies Used

- Ruby v2.6.5
- Ruby on Rails v5.2.4.3

## :rocket: Getting Started

### Dependencies

- SQLite3
- Devise v4.7.2
- Bulma v0.9.0
- Gravatar Image Tag v1.2
- Simple Form v5.0.2

### Configuration

1. [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
2. Install Ruby on Rails
```
gem install rails -v 5.2.3
```
3. [Install SQLite3](https://www.sqlite.org/download.html), if you don't already have it installed locally.
4. Clone repo into your local environment using your favourite terminal:
```
git clone [this-repo-url].git
```
5. Open project directory
```
cd directory-name
```
6. Bulk install dependencies
```
bundle
```
7. Set up database
```
rake db:migrate
```
8. Run Locally
```
rails s
```
9. Visit http://localhost:3000/

## Author

👤 **Clifton Davies**

- Github: [@githubhandle](https://github.com/cliftondavies)
- Twitter: [@twitterhandle](https://twitter.com/cliftonaedavies)
- Linkedin: [linkedin](https://www.linkedin.com/in/clifton-davies-mbcs/)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

1. Fork it
2. Create feature branch
`git checkout -b feature/fooBar`
3. Commit changes
`git commit -am 'Add some fooBar'`
4. Push to the branch
`git push origin feature/fooBar`
5. Create new Pull Request

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Andy Leverenz

## 📝 Copyright & License

Copyright (c) 2020 Clifton Davies.
This project is licensed under [MIT](https://opensource.org/licenses/MIT). See LICENSE file for details.