Documentation-System ¶

1. Introduction
2. Core Features
3. Note
4. Getting Started
5. Technologies and Tools
6. ERD
7. GitHub repo

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 documentation. Each documentation will have its files. Each file will have its version. Each version will have its content. Each content will have its author. Each author will have its 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 software development life cycle phase.

• Get a list of all documentation for each software development life cycle phase.

• Get all files for each documentation.

• Best practices for GraphQL API design.

• Scalable folder structure for GraphQL API design.

Getting Started ¶

 1# clone the repo
 2git clone https://github.com/Adosh74/Documentation-System
 3
 4# Move to the project directory
 5cd Documentation-System
 6
 7# install all dependencies.
 8npm run build
 9
10# sync prisma with database
11npm run prisma:deploy
12npm run prisma:generate
13# After that, fill the .env file with your database credentials
14
15# Start all processes with one command
16npm start

• Now, you can access the Next.js app on

  1http://localhost:3000
  

• And GraphQL Playground on

  1http://localhost:3001/graphql
  

Technologies and Tools ¶

• Node.js
• Express.js
• TypeScript
• GraphQL
• Apollo Server
• Apollo Client
• PostgreSQL
• Prisma
• Next.js

Repo ¶

GitHub - Adosh74/Documentation-System: 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.

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...

https://github.com/Adosh74/Documentation-System

ERD ¶

Entity Relationship Diagram ¶

Table of Contents ¶

Project:

SRS:

SDD:

Backlinks

• 🧑‍💻 Home Friday 13 September 2024