vincentmuriuki / ah-frontend-thor

The deployed version of the app on heroku is

Authors Haven - A Social platform for the creative at heart.

Vision

Create a community of like minded authors to foster inspiration and innovation by leveraging the modern web.

---

Build status

Usage

• A user that is not logged in can only view articles.
• A User has to create an account.
• User can then login and have access to all the other parts of the app.

Features

• Users can create an account and log in.
• Users can post articles.
• Users can delete the articles they post.
• Users can post comments to articles.
• Users can view the articles with comments.
• Users can favorite article.
• Users can follow article authors.

How to install the project dependencies

• The package manager used for this project is Yarn
• To install yarn visit the offical docs Yarn .
• After installing yarn, install the dependencies using the command yarn install

How to run the project locally

• Clone this project using git clone https://github.com/andela/ah-frontend-thor.git
• Git checkout to the develop branch
• Install the project dependencies using yarn install in the project root.
• Run the project locally in development mode using yarn start:dev
• It will open the default browser and start the app.
• You can test the app by clicking the through the url.

Team code of conduct.

• Use es6 features(arrow functions and classes) for more concise code.
• All folder names are supposed to be lowercase
• Components names are supposed to follow the pascal case naming convention
• Writing unitests for the one's code is highly encouraged.

How to run the tests

• After following the setup steps above
• To run the project tests use yarn test:dev
• To run the project tests with coverage use yarn coverage

Developed using

• React and Redux
• Fetch Api
• Sass and Bootstrap

Authors

• Team Thor with the help of JP (PO) and Shakira (TTL).

License

MIT