Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 1.52 KB

README.md

File metadata and controls

63 lines (40 loc) · 1.52 KB

NOTAM Team Project

A senior capstone project at the University of Oklahoma, focusing on improving the way pilots access and interact with Notices to Airmen (NOTAMs).

Prerequisites

Ensure you have the following installed on your system:

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/notam-team-project.git
cd notam-team-project
  1. Install the necessary Node.js and Python packages:
npm install
  1. Create a .env file in the project root directory using the provided .env_default template:
cp .env_default .env
  1. Obtain the client-id and client-secret from the FAA NOTAM API. Add these credentials to the .env file:
CLIENT_ID=your_client_id
CLIENT_SECRET=your_client_secret
  1. Install the nodemon package globally:
npm install -g nodemon

Usage

To start the development server, run:

nodemon

Open your browser and navigate to http://localhost:3000 (or the appropriate port) to view the application.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.