From ec6c86c3c78f63da051d53e2247597d56c9c602a Mon Sep 17 00:00:00 2001 From: Custom Commands Date: Wed, 28 Dec 2022 17:26:11 -0600 Subject: [PATCH] Updated README and TODO --- README.md | 49 ++++++++++++++++++++++++++++++++++--------------- TODO.md | 24 ++++++++++++++++-------- 2 files changed, 50 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 2f27a70..f18f154 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,13 @@

Project Manager

- This is a Project manager web ui for programming projects. It creates, reads, updates, and deletes development projects/environments for you in a uniform and customizable way. + This is a Project Management Web Interface for programming projects. It creates, reads, updates, and deletes development projects/environments for you in a uniform and customizable way.
Explore the docs »

- View Demo - · + Report Bug · Request Feature @@ -66,12 +66,16 @@ +This Repository is meant as a Learning project for me and a productivity tool, once up and running. I have **HUGE** plans/ambitions for this project in the future, but for now it remains a humble and simple half-working application.😂 +

(back to top)

### Built With -- [![React][react.js]][react-url] -- [![NODE][node.js]][node-url] +[![React][react.js]][react-url] +[![NODE][node.js]][node-url] + +- And more...

(back to top)

@@ -80,7 +84,8 @@ ### Setup -> **Note**: Do the Server-side Setup first +> **Note** +> Do the Server-side Setup first Server-side: @@ -135,9 +140,12 @@ _For more examples, please refer to the [Documentation](https://github.com/Ninja ## Roadmap -We are starting off with Web projects as a base +For a better idea look at: [TODO](TODO.md) -[TODO](TODO.md) +Current Major Tasks: + +- https://github.com/NinjaSurge/Project-Manager/issues/2 +- https://github.com/NinjaSurge/Project-Manager/issues/3 See the [open issues](https://github.com/NinjaSurge/Project-Manager/issues) for a full list of proposed features (and known issues). @@ -154,14 +162,13 @@ See the [open issues](https://github.com/NinjaSurge/Project-Manager/issues) for - +## Contributing - +

(back to top)

@@ -183,7 +190,7 @@ Distributed under the MIT License. See `LICENSE.txt` for more information. ## Contact -NinjaSurge - [@KaehlenR](https://twitter.com/KaehlenR) - rayktd@gmail.com +[NinjaSurge](https://github.com/ninjasurge) - [@KaehlenR](https://twitter.com/KaehlenR) - rayktd@gmail.com Project Link: [https://github.com/NinjaSurge/Project-Manager](https://github.com/NinjaSurge/Project-Manager) @@ -194,6 +201,7 @@ Project Link: [https://github.com/NinjaSurge/Project-Manager](https://github.com ## Acknowledgments - [NinjaSurge](https://github.com/ninjasurge) +- Thanks to all the AMAZING maintainers of the Technologies used in this project.

(back to top)

@@ -213,7 +221,18 @@ Project Link: [https://github.com/NinjaSurge/Project-Manager](https://github.com [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/linkedin_username [product-screenshot]: images/screenshot.png + + + [react.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB [react-url]: https://reactjs.org/ + + + [node.js]: https://img.shields.io/badge/Node-333?style=for-the-badge&logo=nodedotjs&logoColor=#339933 [node-url]: https://nodejs.org/ + + + +[sass]: https://img.shields.io/badge/sass-CC6699?style=for-the-badge&logo=sass&logoColor=fff +[sass-url]: https://sass-lang.com/ diff --git a/TODO.md b/TODO.md index a0001a6..2b18efd 100644 --- a/TODO.md +++ b/TODO.md @@ -3,14 +3,15 @@ ## Backend - [x] Make an example Project directory and structure it -- [ ] CRUD - - [x] Project CRUD - - [ ] Project Content/Files CRUD - - [ ] File CRUD +- [ ] CRUDV + - [ ] https://github.com/NinjaSurge/Project-Manager/issues/2 + - [ ] Project Content/Files CRUDV + - [ ] File CRUDV - [ ] Creation - [x] Read - [ ] Update - [ ] Deletion + - [ ] Validation - [ ] Make usable projects - [ ] run commands/scripts in the directory on creation - [ ] Initialize git in the project @@ -21,17 +22,24 @@ - [ ] Make a Project "Home page" - [x] Display a README in markdown - [ ] https://github.com/NinjaSurge/Project-Manager/issues/1 -- [ ] Make a Project Listing Page. +- [ ] Make a Project Listing Page + - [x] Listing Component + - [ ] List Item Styling - [ ] Make a Project Creation form + - [ ] Creation + - [ ] Editing + - [ ] Validation ## General Features -- [ ] Allow tags/categorization for projects -- [ ] Make a template for Project READMEs -- [ ] Documentation Tab - [ ] Tightly Integrate with git!! +- [ ] Make a template for Project READMEs +- [ ] Documentation Tab for Project +- [ ] Allow tags/categorization for projects +- [ ] !!NOT IMPORTANT!! - Tutorial/Wiki ## Optional Features - [ ] Minimalistic Built-in Text Editor - [ ] Mobile/Native Apps +- [ ] Nextcloud Integration??