To-Do List

GDSC's Fall 23 Workshop Project to learn how to a To-do List project using Vite + React.

Description

Before you start, please install the resources below:

• Visual Studio Code: https://code.visualstudio.com/download
• Git Bash: https://git-scm.com/downloads

GDSC README Template: https://github.com/USFGDSC/ReadMeTemplate

Final Project

Technologies used:

React, CSS

Summary of the DevShop:

1. VS Code installed


2. GitHub Account created/logged in
Having trouble? Go to: https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account


3. Git Bash Installed and configurated:
Open Git Bash in your computer and type:
• git config --global user.name "Your name"
• git config --global user.email youremail@example.org
Attention: ***Git email must be the same GitHub email***


4. Create a new repository on GitHub
• Step 1: Select the dropdown menu, click on "Your repositories." This will take you to a page that lists your existing repositories (if any).
• Step 2: On the "Your repositories" page, click the green "New" button. This button is located on the right side of the page, just above your repository list.
• Step 3: Fill in Repository details, make sure to choose to add a README file. Once you've filled in the required details, click the green "Create repository" button at the bottom of the page.


5. Initializing the repository using Git:
• Step 1: Navigate to the repository you which to clone
• Step 2: Click the "Code" Button on the repository's main page and copy the HTTPS Url
• Step 3: Open the directory(folder) you want the cloned repository to be in and then, navigate to a new terminal within it
• Step 4: In the terminal run the followings command "git clone 'Insert your HTTPS URL here' " and press Enter


6. Follow DevShop Steps for the project!
If you are lost, navigate to the "complete" branch of the project repository , to catch up


7. How to run the project:
• Step 1: Open the terminal, making sure is in the correct folder.
• Step 2: Write the command "npm install" and press enter
• Step 3: Write the command "npm run dev" and press enter
• Step 4: Now copy and paste the local address that was given to you on your navigator!
• Step 5: If you wan to terminal the program, press "CTRL + C".


8. How to commit a repository:
• Step1: Navigate to Source control on VScode
• Step 2: Ensure you have the modified file code you want to commit
• Step 3: Select the '+' next to the file name for the modified file which you are tying to commit
• Step 4: Write a message in the Entry box to indicate what change/feature has been added
• Step 5: Click the checkmark icon (or "Commit" button) next to the commit message box. This will commit your staged changes.
• Step 6: Click the "..." (more options button) button in the Source Control panel, and select "Push" to push your changes to the remote repository.




9. Go to your updated repository and edit your README. You can use GDSC README Template: https://github.com/USFGDSC/ReadMeTemplate
This is really important to mantain an organized repository and facilitate the access to anyone that wants to look your project!

Created with ❤️ in DevShops