Organize Your SDLC Effortlessly: The Doc Hub
Introduction
This app is where you will store your Software Development Life Cycle Documentation. This application includes some common phases of software development: Project Initiation, Planning, Requirements (Analysis), Design, Development, Testing, Deployment, and Maintenance. Each phase will have its own documentation. Each documentation will have its own files. Each file will have its own version. Each version will have its own content. Each content will have its own author. Each author will have its own name.
note:
I tried uploading files with the main server but it's not working because apollo/server v4 has an issue and restriction with file upload, so I created another server for uploading files.
If apollo/server v4 fixes this issue, I will update this app.
Core Features
Create, Read, Update, and Delete (CRUD) documentation for each phase of the software development life cycle.
Get a list of all documentation for each phase of the software development life cycle.
Get all files for each documentation.
Best practices for GraphQL API design.
Scalable folder structure for GraphQL API design.
Getting Started
# clone the repo
git clone https://github.com/Adosh74/Documentation-System
# Move to the project directory
cd Documentation-System
# install all dependencies.
npm run build
# sync prisma with database
npm run prisma:deploy
npm run prisma:generate
# After that, fill the .env file with your database credentials
# Start all processes with one command
npm start
- Now, you can access the the Next.js app on
http http://localhost:3000 - And GraphQL Playground on
http http://localhost:3001/graphql
Technologies and Tools
- Node.js
- Express.js
- TypeScript
- GraphQL
- Apollo Server
- Apollo Client
- PostgreSQL
- Prisma
- Next.js
Download Details:
Author: Adosh74
Official Github: https://github.com/Adosh74/Documentation-System
License:
