Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/cliftondavies/readar

A React/Redux web app for managing a reading list.
https://github.com/cliftondavies/readar

css3 heroku html5 javascript npm prop-types react react-dom react-redux redux scss

Last synced: 3 days ago
JSON representation

A React/Redux web app for managing a reading list.

Awesome Lists containing this project

README

        

# Readar

> A web app to keep track of, organize and manage a reading list.

## :tv: Media

[Live Demo Link](https://readar.herokuapp.com/)

## :toolbox: Tools & Technologies Used

### Built with

- HTML5
- CSS3
- JavaScript ES6
- React 17.0.1
- Redux >4.0.5

## :rocket: Getting Started

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

### Prerequisites

Install [npm](https://www.npmjs.com/get-npm) or [Yarn](https://yarnpkg.com/cli/install)

Install [Node.js](https://nodejs.org/en/download/)

### Set up

Clone repo into your local environment:

Clone with SSH

```git
git clone [email protected]:cliftondavies/Magic-Books.git
```

Clone with HTTPS

```git
git clone https://github.com/cliftondavies/Magic-Books.git
```

Open project directory

```bash
cd [your-directory-name]
```

Install packages:

```javascript
npm install
```

### Local Usage

#### In console

```javascript
npm start
```

#### In Browser

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!

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgements

- [create-react-app](https://github.com/facebook/create-react-app)
- [Heroku buildpack for create-react-app](https://github.com/mars/create-react-app-buildpack)

## 📝 Copyright & License

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