bertrandconxy / demopedia

Demopedia is a web app that provides demographic data of different countries. Users can perform CRUD operation to database. That means Reading and Adding new countries, Updating and Deleting countries.

Demopedia

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Demopedia]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
      • GraphQL API Server
        • MongoDb Atlas Set up
      • Testing GrapQL API
      • Running the Frontend
    • Run GraphQL query Tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Demopedia]

Demopedia is a Full stack web app which enables users to view countries demographic data. On top of that, they can perform CRUD operations on the database. Backend is implemented using the MongoDb Atlas, Apollo Server and GraphQL API. The Frontend is implemented using Next.js and Apollo Client.

🛠 Built With

Tech Stack

Client

• Next.js
• Apollo client

Backend & Server

• Apollo Server
• MongoDB Atlas
• GraphQL

Key Features

• GraphQL interface
• View Country demographic
• Creating, Updating and Deleting country data

(back to top)

🚀 Live Demo

Not yet deployed

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Nodejs
• Yarn
• MongoDB Atlas

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/BertrandConxy/Demopedia.git

Install

Install this project with:

  cd Demopedia
  npm install

Usage

GraphQL API Server

MongoDb Atlas Set up

You will need DB URI to connect to the database. After setting up the MongoDb Atlas:

• Create .env file.
• Assign db URI to the DB_URI environment variable

Run the server:

npm run server

You will get The following output:

🚀 Server ready at http://localhost:4000/api/countries
Database connection successful!
seed data was added successfully

Testing GrapQL API

If you run the above url while the server is running, it will open up Apollo server sandbox:

Running the Frontend

While the server is running, open another terminal and change the directory to frontend:

cd frontend

Install all the packages:

npm install

Run the development server:

npm run dev

Quick Preview

Run GraphQL query Tests

To run tests, run the following command:

  npm run test

👥 Authors

👤 Bertrand Mutangana Ishimwe

• GitHub: @BertrandConxy
• Twitter: @Bconxy
• LinkedIn: Bertrand Mutangana Ishimwe

(back to top)

🔭 Future Features

• View more info about the country
• Display Demographic data in charts

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please don't hesitate to contact me so that we can see how we can improve it and please give it a star 😎

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)