73 lines
4.3 KiB
Markdown
73 lines
4.3 KiB
Markdown
# :large_blue_diamond: FauxJira - A simplified Jira clone built with React and Node
|
|
|
|
This is a maintained fork of [the demonstrative project by Ivor Reic](https://github.com/oldboyxx/jira_clone) that strives to be a full alternative to Jira or other project management tools. Currently it's working for demonstration purposes, but is missing authentication and more.
|
|
|
|
**As opposed to the original project, we *do* accept Pull Requests and would be glad to receive lots of them!**
|
|
|
|
<h3>
|
|
<!--<a href="https://jira.ivorreic.com/">Visit the live app</a> |-->
|
|
:memo: <a href="https://github.com/FauxJira/FauxJira/tree/master/client">Client</a> •
|
|
<a href="https://github.com/FauxJira/FauxJira/tree/master/api">Server/API</a><br>
|
|
:speech_balloon: <a href="https://rocket.fauxjira.xyz">Discussion on Rocket.Chat</a>
|
|
</h3>
|
|
|
|
|
|
|
|
## What is this and who is it for 🤷♀️
|
|
|
|
This originated in a showcase product by Ivor Reic. It's a very good example of modern, real-world React codebase.
|
|
|
|
We want to build upon it in this fork and create a real, usable application for project management.
|
|
|
|
> There are many showcase/example React projects out there but most of them are way too simple. I like to think that this codebase contains enough complexity to offer valuable insights to React developers of all skill levels while still being _relatively_ easy to understand.
|
|
|
|
## Features
|
|
|
|
- Proven, scalable, and easy to understand project structure
|
|
- Written in modern React, only functional components with hooks
|
|
- A variety of custom light-weight UI components such as datepicker, modal, various form elements etc
|
|
- Simple local React state management, without redux, mobx, or similar
|
|
- Custom webpack setup, without create-react-app or similar
|
|
- Client written in Babel powered JavaScript
|
|
- API written in TypeScript and using TypeORM
|
|
|
|
## 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/FauxJira/FauxJira.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 at the current state which we're working on:
|
|
|
|
### 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).
|
|
|
|
### Accessibility ♿
|
|
|
|
Not all components have properly defined [aria attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA), visual focus indicators etc. Most early stage companies tend to ignore this aspect of their product but in many cases they shouldn't, especially once their userbase starts growing.
|
|
|
|
### Unit/Integration tests 🧪
|
|
|
|
Both Client and API are currently tested through [end-to-end Cypress tests](https://github.com/FauxJira/FauxJira/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.
|
|
|
|
## Contributors
|
|
- [Ivor Reic](https://getivor.com/): Original Author
|
|
- [Leopere](https://github.com/Leopere): Creator of this Fork
|