Simple Partner Base

A simple partner database using the MERN stack of softwares to provide basic database searching, editing, creating, and deleting!

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. Contact
7. Acknowledgments

About The Project

A simple partner database using the MERN stack of softwares to provide basic database searching, editing, creating, and deleting! This project uses a mix of softwares that make editing and styling the user interface and the backend easy and intuitive!

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps:

Prerequisites

Since we implemented docker, to make the download and run process more streamlined, all you need are:

1. docker: download their interactive desktop from their website!
2. and git!

• for Windows
• for linux:

 sudo apt-get install git

Installation

1. Clone the repo (or download the .zip)

   git clone https://github.com/violet-isle/mern-stack.git

2. Then just navigate to mern-stack and run:

   sudo docker compose up

And then it should be running! To connect, type in localhost:5170 in your browser. Don't forget to add an initial community partner into the database before you expect to see data in the table.

(back to top)

Usage

This project can be used in many ways, and although it was designed for storing community partners of our local career center, it can be used for other institutions storing partners, or any other database application with minor tweaks to the code!

(back to top)

Roadmap

• Add Google OAuth
• Add further user restrictions and functionalities
• Ability to edit contacts specifically, and add multiple contacts to a specific community partner

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 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)

Contact

Violet Strozykowski - [email protected]
Austin Jacobs - [email protected]

Project Link: https://github.com/violet-isle/mern-stack

(back to top)

Acknowledgments

• Mohammad Taheri's video series on the MERN stacks
• NHN TV's video series on implementing live search functionality into REACT
• Avik Kundu's article on Dockerizing a MERN stack application
• Net Ninja's video series on adding authentication to a MERN stack application

(back to top)