awangran/shu-app

🌷

Shu Local Library

A personalized library for the cultured geeks

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

Project made with the intention to learn more about express and react. Run a library locally and save your favorite media so that no one else can see your embarrasing taste in books.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

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

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/github_username/repo_name.git

2. Install NPM packages

   npm install

3. Run npm start on both frontend and backend directories. Change ports in app.js and server.js if needed.

(back to top)

Usage

You are able to edit, add, and delete items in your library.

(back to top)

Roadmap

• Add read me
• Add dark mode
• Edit images
• Add filters
• Add multiple views
• Run on mongo (toolazy)

(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

License

Distributed under the MIT License.

(back to top)