FNCUnited React Frontend

The FNCUnited App will consist of three portions: collection, storage, and analysis. This project specifically targets the analysis portion through building a React frontend as a baseline for somewhere to create graphs, tables, etc.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

The live version on GCP is currently managed by Teesh. The app itself was bootstrapped using Create React App. The Docker portion of this app is just for sanity checking to make sure it will build on GCP as intended.

Prerequisites

Use the following steps to get the app running on your local machine

• Node JS

  https://nodejs.org/en/download

• npm

  npm install npm@latest -g

• Docker Desktop (for local testing only). Be aware, Windows machines may need additional setup not covered here

  https://www.docker.com/products/docker-desktop/

Installation

1. Clone the repo

   git clone https://github.com/Teesh/fnc-recon-frontend.git

2. Create a .env file in the main directory and add the following line

   REACT_APP_ENVIRONMENT=local

3. Install NPM packages

   npm install

4. Start the React app in development mode

   npm start

5. (Optional) Start the React app in Docker. Make sure Docker is running first.

   docker-compose up -d

(back to top)

Usage

The app is a blank slate at the moment, with goal of allowing devs to quickly start a blank React app and try new things with it. No functionality has been added and there in no integration with other portions of the FNC United app at this time.

For more examples, please refer to the Documentation (Placeholder)

(back to top)

Roadmap

• Test and agree on a graphing/visualization library
• Build simple charts to pull data from FNC United API
• Build a test view for inserting data into a development database
• Agree on some simple metrics for display
• Utilize an API key

See the open issues for a full list of proposed features (and known issues). Feel free to add or track issues there for now. They can be migrated to the official repo later once that is built.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. As a proof of concept, the work here will eventually be migrated to an official team repository.

Until then, if you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Find us on the FNC Scouting Discord https://discord.gg/kxeqeJsyta or reach out to us via email at ncfrcscouting@gmail.com

Project Link: https://github.com/Teesh/fnc-recon-frontend

(back to top)

Acknowledgments

• RoboEagles 4828, Terrorbytes 4561, Yeti 3506, Omegabytes 5727, and the 20+ FNCU teams for their support and vision in this project

(back to top)