GraphCMS is a robust, full stack application designed to manage clients and associated projects. The application is developed using the MERN stack (MongoDB, Express.js, React.js, Node.js), with GraphQL used to streamline the API for cleaner, more efficient operations. The Apollo Client is employed to manage state on both local and server sides within the React framework.
The repository is organized into the following key directories:
client/: This contains all of the front-end code for the React.js application.server/: This directory houses the server-side code, built using Express.js and GraphQL.
In order to set up and run the full stack application, follow the step-by-step instructions detailed below:
- Navigate to the Backend Directory
cd project-and-client-management-graphql/server
- Install Dependencies
Run the following command to install all required dependencies:
npm install
- Set up Environment Variables
Create a .env file in the directory. Add the following line, replacing <your_mongoDB_uri> with your MongoDB URI:
MONGO_URI=<your_mongoDB_uri>
- Start the Backend Server
You can start the backend server using:
node index.js
At this point, your server should be up and running at http://localhost:5500.
- Navigate to the Frontend Directory
cd project-and-client-management-graphql/client
- Install Dependencies
Similar to the backend, run the following command to install necessary dependencies:
npm install
- Start the Local Development Server
You can start the local development server using:
npm start run
You should now be able to access the full application at http://localhost:3000.
The GraphCMS application supports a wide range of operations, including:
- Adding new clients
- Viewing existing clients
- Updating client details
- Deleting clients
- Adding new projects associated with clients
- Viewing existing projects
- Updating project details
- Deleting projects
In the frontend, the Apollo Client is used to make GraphQL requests to the backend. The backend server processes these requests, responding with data that is then used to update the UI in real-time.
The backend serves as the foundation for the GraphQL API, which is used by the frontend for a variety of operations. Built with Node.js and Express.js, it leverages MongoDB for data storage. The server setup can be found in the server.js file, and the GraphQL schema is defined within the schema/schema.js file.
Contributions to the GraphCMS project are very much welcomed and appreciated! If you come across any bugs or issues, please file an issue for it. If you have any feature requests or wish to make a contribution, you can submit a pull request.
The GraphCMS project is licensed under the terms of the MIT License. You can find the terms and conditions of the license in the LICENSE.md file located in the project repository.