Skip to content

Latest commit

 

History

History
94 lines (74 loc) · 3.36 KB

README.md

File metadata and controls

94 lines (74 loc) · 3.36 KB

Neurotech Frontend Challenge

                 

✨ About the project:

  • 🏹 A frontend challenge proposed by Neurotech.
  • 📌 A simple and easy to-do website with login page.
  • 🎨 The proposed model can be found in figma.
  • 🥼 The backend is on neurolake's github.
  • 😎 It was not necessary to deploy the application, but I did it in netlify.

💻 Project status:

  • Finished project ✔️

🛠 Technologies:

  • HTML
  • CSS
  • TypeScript
  • React
  • Styled-Components
  • Vite
  • JavaScript
  • NodeJS
  • Netlify

📝 Features:

  • Allows user to login with github username.
  • Allows user to add, remove and edit tasks.
  • By logging in and reloading the page, the user will not need to login again.
  • Allows user to reload tasks.

⚙️ Prerequisites:

  • Internet access - Browser

  • Node.js

🚀 How to run the application?

  • 🌎 Go to the application website.

    or

  • 💻 Download the ZIP or Clone the application on your machine;

  • 🎨 Frontend

    • Open CMD and navigate to 'frontend' folder: cd frontend,
    • Install node/react modules: yarn install,
    • Finally start a localhost: yarn dev.
  • 🎲 Backend

    • ⚙ Config
      • First create a database for free in MongoDB,
      • There is a step by step file in the docs folder,
      • Inside the backend folder create the .env file,
      • Inside the file insert: MONGO_URI="your_mongo_uri".
    • 💠 Run
      • Open another CMD in the root of the project folder,
      • Navigate to 'backend' folder: cd backend,
      • Install node modules: yarn install,
      • And run the backend with yarn start.

📝 License

  • This project is licensed under the MIT

👨🏽‍💻 Author

Author's photo
Made by Arthur V.B.S✌🏽