ArturTkaczuk/Aplikacja-notatnik-fullstack

Simple MERN stack CRUD app using MongoDB database

Aplikacja-notatnik-fullstack

MERN stack CRUD app using MongoDB database with Nodejs Express REST API. Check it Live here

Table of Contents

• Requirements
• Installation
• Usage
• Technologies
• Features
• Support
• Contributing
• License

Requirements

• Latest web browser to run app on website (Google Chrome)
• To run git commands you need Git installed
• To run npm commands you need node installed

Installation and setup

a) Download project via git

Run this command in terminal to download repository:

git clone https://github.com/ArturTkaczuk/Aplikacja-notatnik-fullstack.git

frontend install dependencies

cd Aplikacja-notatnik-fullstack/frontend
npm install

backend install dependencies

cd Aplikacja-notatnik-fullstack/backend
npm install

b) Download project manually from GitHub

1. Download project from this link
2. Go through terminal commands listed above to install all dependencies

Usage

Useful commands:

Run in Aplikacja-notatnik-fullstack/frontend:

1. Dev server npm run start
2. Production build npm run build

Run in Aplikacja-notatnik-fullstack/backend:

1. Run server node index.js
2. Run server tests npm test

Technologies

Technologies used during development process:

Frontend:

• Create-react-app TypeScript
• Material UI
• Axios
• HTML

Backend:

• Express framework

Backend API tests:

• supertest testing library
• jest

Database:

• Mongoose (MongoDB schema-based solution)

Features

• CRUD notes operations
• Frontend in CRA-TypeScript hosted on netlify
• NodeJS REST API in Express hosted on render.com
• NoSQL database integration hosted on MongoDB Atlas
• 11 working Backend API tests

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

License

You can check out the full license here.

This project is licensed under the terms of the MIT license.