59 lines
2.8 KiB
Markdown
59 lines
2.8 KiB
Markdown
<h1 align="center">A simplified Jira clone built with React and Node</h1>
|
|
|
|
<div align="center">Auto formatted with Prettier, tested with Cypress 🎗</div>
|
|
|
|
<h3 align="center">
|
|
<a href="http://jira.ivorreic.com/">Visit the live app</a> |
|
|
<a href="https://github.com/oldboyxx/jira_clone/tree/master/client">View client</a> |
|
|
<a href="https://github.com/oldboyxx/jira_clone/tree/master/api">View API</a>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
## Setting up development environment 🛠
|
|
|
|
- Install [postgreSQL](https://www.postgresql.org/) if you don't have it already and create a database named `jira_development`.
|
|
- `git clone https://github.com/oldboyxx/jira_clone.git`
|
|
- Create an empty `.env` file in `/api`, copy `/api/.env.example` contents into it, and fill in your database username and password.
|
|
- `npm run install-dependencies`
|
|
- `cd api && npm start`
|
|
- `cd client && npm start` in another terminal tab
|
|
- App should now be running on `http://localhost:8080/`
|
|
|
|
## Running cypress end-to-end tests 🚥
|
|
|
|
- Set up development environment
|
|
- Create a database named `jira_test` and start the api with `cd api && npm run start:test`
|
|
- `cd client && npm run test:cypress`
|
|
|
|
## What's missing?
|
|
|
|
There are features missing from this showcase API which should exist in a real product:
|
|
|
|
### Migrations 🗄
|
|
|
|
We're currently using TypeORM's `synchronize` feature which auto creates the database schema on every application launch. It's fine to do this in a showcase product or during early development while the product is not used by anyone, but before going live with a real product, we should [introduce migrations](https://github.com/typeorm/typeorm/blob/master/docs/migrations.md).
|
|
|
|
### Proper authentication system 🔐
|
|
|
|
We currently auto create an auth token and seed a project with issues and users for anyone who visits the API without valid credentials. In a real product we'd want to implement a proper [email and password authentication system](https://www.google.com/search?q=email+and+password+authentication+node+js&oq=email+and+password+authentication+node+js).
|
|
|
|
### Unit/Integration tests 🧪
|
|
|
|
Both Client and API are currently tested by through [end-to-end Cypress tests](https://github.com/oldboyxx/jira_clone/tree/master/client/cypress/integration). That's good enough for a relatively simple application such as this, even if it was a real product. However, as the app grows in complexity, it might be wise to start writing additional unit/integration tests.
|
|
|
|
### Author: Ivor Reic ✍️
|
|
|
|
- Website: https://codetree.co/
|
|
- Skype handle: ivor.reic 💬
|
|
|
|
<hr>
|
|
|
|
<h4>
|
|
<a href="http://jira.ivorreic.com/">Visit the live app</a> |
|
|
<a href="https://github.com/oldboyxx/jira_clone/tree/master/client">View client</a> |
|
|
<a href="https://github.com/oldboyxx/jira_clone/tree/master/api">View API</a>
|
|
</h4>
|