Table of Contents
This is a personal project for practicing skills and it is not intended to work as a real Jira application. It is still in early development and some features and improves are coming.
For pragmatic purposes, many features are not included. Others have been modified according to my tastes. The application should serve the basic functionalities of a project management software. I have taken inspiration from the actual Jira Website, as well as from Trello.
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
-
Clone the repo
git clone https://github.com/AnhTranThe/FA.Project-Management.git
-
Install yarn packages
npm install --global yarn
-
Check yarn version
yarn --version
-
Add .env file follow sample .env
-
Install dependencies using Yarn with npm fallback.
yarn install
To run the application in dev mode, execute the following command:
yarn dev
This project uses Tailwind CSS, so this command will concurrently run the Tailwind CSS compiler in watch mode.
To build a compiled version of the application, execute the following command:
yarn build
The app simulates Jira's workspace, there are 2 roles (Administrator and Customer). For each role, user will access to each authorization. Administrator can create, update project and delete project. or set host project to identified customer, when customer is host of project, they can
- Add Changelog
- Add back to top links
- Add Additional Templates w/ Examples
- Add "components" document to easily copy & paste sections of the readme
- Multi-language Support
- Chinese
- Spanish
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Your Name - @your_twitter - [email protected]
Project Link: https://github.com/your_username/repo_name
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!