2Do Project

| Matt DePauw | Sandra Lwin | Walter Toriola | Katy Tran |

`Product Vision`

For anyone who wants to maximize their work/life balance. 2Do is an efficient and concise To-Do list that organizes daily tasks in an accessible and easy to read manner. Unlike Microsoft To Do, Our Product is lightweight, customizable, easy to manage and fun!

`Project Setup Instructions`

Both Frontend and Backend need to be running to achieve running 2Do.

`Backend Setup`

First change the name of the env file to .env file in the root 2Do folder.
Open 2do_be folder on terminal/command line.
run the command npm i.
After installation, run the command npm run dev to start up the backend.
If successful, terminal will print The mongoose is listening.
The backend is now up and running on http://localhost:5001.

`Frontend Setup Instructions`

Open 2do_fe folder on terminal/command line.
run the command npm i.
After installation, run the command npm start to start up the frontend.
If successful, 2Do webpage will be opened on http://localhost:3000/

`Project Design`

https://www.figma.com/file/uHDBQEXPRQJdATXyNeKNJw/2Do_307?node-id=0%3A1

`Backlog`

https://github.com/users/mattriots/projects/2/views/1

`Project Build badges`

`Prettier: Code Formatter`

Setup Instructions

Select the extensions icon from the left side of your VScode window
Search for 'Prettier' and download
Go to preferences > settings and search for 'Prettier'
Scroll down until you see 'Config Path' and point to the '.prettierrc' that is in the root folder of the respository.

Style Guide

React/JavaScript [https://airbnb.io/javascript/react/]

`EsLint: Find and Fix Problem in JavaScript`

Setup instructions:

Select the extensions icon from the left side of VScode window
Search for 'EsLint' and install
Open terminal for the desire folder with existing npm and package.json
Enter: 'npm init @eslint/config' command in terminal
When prompt to answer question make sure to chose the following:
- ? How would you like to use ESLint? >To check syntax and find problem
- ? What type of modules dows your project use? >JavaScript
- ? Which frameword does your project use? >React
- ? Does your project use TypeScript? >No
- ? Where does your code run? >Browser
- ? What format do you want your config file to be in? >JSON
- ? Would you like to install them now? >Yes
- ? Which package manager do you want to use? >npm
'.eslintrc.json' will be created
Replace the content in the '.eslintrc.json' that was created with the content in '.eslintrc.json' file the that is in the root folder of the repository by copy/paste.

Setup database:

create a file named .env
add .env to .gitignore
Update the user and password fields below with your mongodb atlas user and password

MONGO_USER=XXXXX MONGO_PWD=XXXXX MONGO_DB=XXXXX MONGO_CLUSTER=XXXXX

`License`

Copyright [2021] [2Do]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

mattriots / 2Do

readme