README.md

MyLibbb

A library inventory app created using MERN stack

• MyLibbb
  • Why this app as created:
  • How to use:
  • Testing tools used for app:
  • Project resources:
    • Future app goals:
    • Completed tasks:

Why this app as created:

Proof of concept: App was developed as a demo/testing app for a future SaaS app.

How to use:

1. Clone repo into desired directory git clone https://github.com/tjdev7/MyLibbb.git or gh repo clone tjdev7/MyLibbb
2. Run npm install in your terminal to install all app node modules and dependencies
3. Run yarn start in your terminal to run app on http://localhost:3000/

Testing tools used for app:

• React Testing library
• Jest
• Mocha
• Cypress
• Webpack
• TravisCI
• CircleCI
• ESLint, CSSLint and StyleLint

Project resources:

• Documentation for project contributors

Future app goals:

• Finalize UI design for app
• Add functioning backend for app
• Add free API service to app
• Separate React components
• Develop multiple tests for entire project

Completed tasks:

• Complete initial UI design for app
• Add React, Webpack, babel and ESlinter to app