We start at the landing page. Where we can login through Github or sign up to authorize and install the app. Afterwards we'll be redirected to the project dashboard, where we can access an existing project or create a new one. Once we have selected an option we will navigate to the main dashboard.
To the left we can see our sidebar. Here we can add teammates to the current project or switch between existing ones, as well as create a new one. In the center we can see the milestones, these allow us to break the development of our project into its main building blocks. To the right we have the Feed view, where we have access to the latest pull requests done to our repos.
Each milestone will take us into a board view of all the tasks associated. These are organized by their status (To do, in progress, to review and done, as well as a backlog section.) Tasks are created here. We can add a title, description, status,priority, tags, due date and a PR link. This link will help us keep track of any movements on that pull request and display them in the feed as well as update the status of the task associated.
These tasks can also be filtered according to the tags, priority and status.
Finally the documentation page allows us to share useful resources with our team. The docs can contain text and code blocks.
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
-
Clone the repo
git clone https://github.com/lexarisa/alena.git
-
Install NPM packages
npm install
-
Add the .env variables
PORT = 3000;
DATABASE_URL = 'postgresql://janedoe:mypassword@localhost:5432/mydb? schema=sample';
For the backend run:
npm start;
For the frontend run
npm run start;