Fitz-Net

A collection of software to host @Mattlol85's ideas
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

The Fitz-Net is a long standing idea of what I, @mattlol85 have always wanted and dreamed of. At the bare minimum, the Fitz-Net is a website that I can develop new ideas on, and have a physical place on the internet to access it from. Currently, there are two main components to the Fitz-Net, a React-based website, and a Spring API to go alongside it.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them. Keep in mind that parts of the project are intened to run on specific hardware.

Unix:

• Update packages & Install JDK 17

  sudo apt update
  sudo apt install openjdk-17-jdk gradle git -y 

• Install Node Package Manager (npm)

  sudo apt install npm
  npm install npm@latest -g

Windows:

Info: Highly reccomend you use a WSL distro to work on this project.

Installation

1. Clone the repo and initialize and update submodules.

   git clone https://github.com/mattlol85/Fitz-Net.git
   cd Fitz-Net
   git submodule init
   git submodule update

2. Open Website Repo

   cd fitz-net-website

3. and or Fitz-Net API Repo

   cd fitz-net-api

   Warning: If the directories are empty make sure you run the submodule init and update commands!

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Complete a 1.0 release of Fitz-Net and its modules
• Create a hardware client that runs the API
• Design remote client that calls API. (A raspberry pi with buttons that connected to the API)
  • 3D Print, and upload files to Github

See the open issues for a full list of proposed features (and known issues).

(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 to the Fitz-Net are greatly appreciated.

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". Don't forget to give the project a star! Thanks again!

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

Your Name - @mattylol85 - mattlol85@gmail.com

Project Link: https://github.com/mattlol85/Fitz-Net

(back to top)

Acknowledgments

• Me
• Myself
• I

(back to top)