Active Stories

Introduction

Active Stories is an application which helps users create and manage user stories. This helps make the process of breaking tasks into manageable user stories easy amd seamless.

Features

the app has the following features:

• A User can:

  • create an account and login.
  • create user stories.
  • view all his/her stories.
  • view details of a story.

• An admin can:

  • stories are automatically marked as pending and can be approved/rejected by any admin
  • approve or reject a story.
  • view all stories on the application.
  • view the details of a story.

Installation

To run the app locally, setup a local development environment. Ensure that Nodejs and PostgreSQL are installed on your machine.

1. Clone the repository: git clone git@github.com:Veraclins/active-stories.git.
2. Navigate to the project directory: cd active-stories
3. Install dependencies: yarn.
4. Change .env-example to .env cp .env.example .env.
5. Create a postgres database and update .env with the credentials
6. Run yarn start to start the app with hot reloading.
7. visit http://localhost:3000 (or any port set in the .env file) see docs for endpoints and requirements.

Testing

To run the tests:

1. Ensure you have run the installation process above.
2. Run yarn test

Assumptions

1. The application can be used from a frontend application or a tool such as Postman.
2. The cost is proportional to the estimated time for completion, hence having a mapping of cost to estimated time removes the stress of calculating it from the user. The user only needs to select a cost.
3. While one can login as an admin, an admin can only be seeded or created directly in the database.
4. A rejected story can still be approved and vice versa.