Skip to content

Latest commit

 

History

History
118 lines (73 loc) · 5.08 KB

README.md

File metadata and controls

118 lines (73 loc) · 5.08 KB

Welcome to Student TaskMate

An app that allows students to interact with companies to take on tasks

Table of contents

General info

This app was a team building project created between three people. Student TaskMate allows students and companies to create and login through the web application, which will then take them to the home page. On the homepage, there is a taskbar to the left that displays the users profile and tasks they have picked up. On the feed section, it allows companies to create posts with assigned tasks that students can see and react to if they would like to pick up the project.

Technologies

This project is created with:

  • React
  • Express
  • Node
  • MongoDB
  • Figma

Functionality

  • Login Page - demonstrates user authentication allowing companies or students to log in with their credentials or sign up if they don't have an account
  • Register Page - allows companies and students to create an account by putting in their name, school/company, email, and password
  • Main Page -
    • Navbar - Displays custom logo/icon with its associated project name
    • Taskbar - Displays the user that is signed in along with tasks they have picked up
    • Feed page - Display posts/projects created by companies that can be picked up by students, which can be done by reacting to the post. Also displays a container with textfields allowing companies to create new taks/projects.

Figma Design

Blueprint:

Video Demonstration

Student TaskMate Video

Setup

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify