https://github.com/eugeniobarrosjr/nd-udacity-readable

Readable : Second project of Udacity's React Nanodegree course.
https://github.com/eugeniobarrosjr/nd-udacity-readable

Last synced: about 1 month ago
JSON representation

Readable : Second project of Udacity's React Nanodegree course.

• Host: GitHub
• URL: https://github.com/eugeniobarrosjr/nd-udacity-readable
• Owner: eugeniobarrosjr
• License: mit
• Created: 2019-02-10T00:37:13.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-16T03:37:56.000Z (over 3 years ago)
• Last Synced: 2024-11-09T12:37:20.803Z (3 months ago)
• Language: JavaScript
• Size: 211 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
This project is my implementation of Readable app which is the final assessment project for the

Udacity's React Fundamentals course, part of the [React Nanodegree Program](https://udacity.com/course/nd019).

Readable is a simple content sharing plateform. Users are able to share articles, as well as reading other shared articles. Users are also able to leave comments on articles.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

The project can be built with npm or yarn, so choose one of the approach bellow in case you don't have any installed on your system.

- **Npm** is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer. [Download Node.js](https://nodejs.org/en/download/)

- **Yarn** is a package manager built by Facebook Team and seems to be faster than npm in general. [Download Yarn](https://yarnpkg.com/en/docs/install)

### Installing

To download the project follow the instructions bellow:

```

git clone https://github.com/eugeniobarrosjr/nd-udacity-readable.git

cd nd-udacity-readable

```

Then install dependencies on server and run:

```

cd server

yarn install

yarn start

```

or

```

cd server

npm install

npm run start

```

Then install dependencies and run:

```

yarn install

yarn start

```

or

```

npm install

npm run start

```

## Versions

v1.0

- Default project implementation

## Authors

Eugênio Barros

- [https://github.com/eugeniobarrosjr](https://github.com/eugeniobarrosjr)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details