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

https://github.com/cliftondavies/micro-reddit

A lightweight Reddit clone.
https://github.com/cliftondavies/micro-reddit

ruby ruby-on-rails sqlite3

Last synced: 17 days ago
JSON representation

A lightweight Reddit clone.

Awesome Lists containing this project

README

          

# Micro Reddit

> An implementation of the data models required for link posts and commenting by users.
**NOTE**: No frontend. Use the Rails console to interact with the database and play around with the models.

## :toolbox: Tools & Technologies Used

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

## :rocket: Getting Started

### Prerequisites

- Ruby
- Ruby on Rails
- SQLite3

### 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 install
```
7. Set up database
```
rake db:migrate
```
8. Run Locally
```
rails console
```

## 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!

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- The Beagles

## 📝 Copyright & License

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