Haadiiii/mars-cdc-data-api

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • API Documentation
  • 🚀 Live Demo
    • Back-end Repository
    • Kanban Board
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Mars-cdc-data-api

This is a web application that allows users to view and interact with data from the Mars CDC. The data is displayed in a table and can be filtered by date, location, and disease. The user can also add new data to the table.

🛠 Built With

Tech Stack

React-Redux (React Redux is the official React UI bindings layer for Redux. It lets your React components read data from a Redux store, and dispatch actions to the store to update state.

Client

• React-Redux

Server

• Node.js

Database

• MongoDB

Key Features

(back to top)

API-Documentation

🚀 Live Demo

• coming soon

(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:

• Node.js installed

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Haadiiii/mars-cdc-data-api.git

Install

Install this project with:

  cd mars-cdc-data-webapp

  npm install

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, run the following command:

  npm run test or npm test

(back to top)

👥 Author

👤 Haamid Ali

• GitHub: @Haadiiii
• Twitter: @HaaDiii_99
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

(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, kindly give as a ⭐️

(back to top)

🙏 Acknowledgments

(back to top)

❓ FAQ (OPTIONAL)

• Why did you choose react?

  • The biggest advantage of using it is that you can change any component at any point in time without affecting the other components. This alone results in widespread support among both clients and service providers.

• What is redux?

  • Redux is simply a store to store the state of the variables in your app.

(back to top)

📝 License

This project is MIT licensed.

(back to top)