afally / artemis

Express,React and Node dashboard application to monitor Exoplanets

ARTEMIS

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation
  • Running the web application
• Rest API Documentation
• Usage
• Contributing
• License

Introduction

ARTEMIS

This is a web application that helps users to track rocket launch dates

• Frontend: ReactJS
• Backend: NodeJS & RestAPI & Expressjs
• Testing: Jest, React testing library, Supertest & MSW

Features

Getting Started

To run this web application on your local machine, follow the steps below:

Prerequisites

Before getting started, ensure that you have the following software installed on your machine:

• Node.js: Download and install Node.js from the official website: https://nodejs.org

Installation

Step-by-step guide on how to install the project and its dependencies.

1. Clone the repository to your local machine using Git:

2. Navigate to the project directory

cd artemis

3. Install the project dependencies using NPM(Node Package Manager):

npm install

4. Navigate to the directory of the react-frontend and express-backend as shown below and install corresponding dependencies

cd  artemis/client

npm install

cd  artemis/server

npm install

Running the web application

Once you have installed the dependencies, you can start the web application (Frontend and Backend concurrently) using

cd  artemis

npm run watch

Usage

• Accessing the homepage: Open your web browser and navigate to http://localhost:3000 to view the homepage.

• Troubleshooting If you encounter any issues or have questions, please feel free to reach out to us by creating an issue on our GitHub repository: https://github.com/ayofalo/artemis/issues.

License

This project is licensed under the MIT License.

Authors

Contributors names and contact info

Ayo Folami