Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.82 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.82 KB
Raw

TODOS APP (ali-aftab)

This is a To-Do List application that allows the user to create, delete, and search tasks. The app was made with React, Next-JS, GraphQL, Apollo, etc.

Requirements

You need Node.js/NPM and Git installed into your system. Note: NPM is bundled with Node.js

Get Started

  1. Fork this repo to your personal
  2. In your terminal type git clone https://github.com/(YOURGITHUBPROFILE)/Todos
  3. Access the folder with cd Todos
  4. Install the required modules with npm install
  5. There are two ways to run this application:
  • Development mode - type npm run dev to run the developer mode of the application (enables hot-code reloading and error reporting)
  • Production mode - type npm run build to build the optimized production build of the application and then type npm run start to run the production build

Testing

To test your code type npm run test into your terminal to see if the current code is passing the specs. To see how much coverage the specs cover the codebase type npm run test:coverage.

How can I contribute to the code?

  1. Follow the commands in the Get Started section of this ReadMe to have a copy of the repo.
  2. Create a new branch and go to the new branch by just typing git checkout -b BRANCH-NAME (replace BRANCH-NAME with a more convenient name).
  3. Change the code any way appropriate with your IDE.
  4. Push your changes to Github using git add ., then git commit -m "TYPE-YOUR-CHANGES-HERE", and git push origin BRANCH-NAME.
  5. Open a pull request and provide detail on what changes you made (make sure you are merging to the right branch).
  6. Get peer-reviewed and if passed, your code got contributed to the project!