Skip to content

Erroders/AskMates

Repository files navigation

AskMates

This application is aimed to provide a platform forcollege students to ask questions, have conversations and discuss doubts.The services of this platform will include:

  • User Accounts (Sign Up/ Sign In) Functionality
  • Ability to Post Questions
  • Answer Question
  • Database Connectivity
  • Password Resetting Functionality
  • Ability to vote answers
  • Searching Functionality

The Express Server Code (Backend) can be found on this link.

Tech Stack

Next JS React NodeJS MySQL Express.js Vercel HTML5 TailwindCSS JavaScript Postman JWT NPM

Video Demo

To be uploaded


Development Setup

Pre Requisites:

  • NodeJS
  • MySQL
  • NPM
  • Yarn
  • Code Editor

Installation

  1. To start development from this repository, first you need to clone it.

  2. After Cloning the Repo first install all the dependencies by running this command in terminal.

    yarn install

    Installs all the dependencies required for the project.

  3. Create a .env file in the root of the project folder and enter the API Key.

  4. Now you can start working on the project.

  5. After all the dependencies are installed you can start the development server by running the following command in the terminal.

    yarn dev
    

    Runs the app in the development mode.
    Open http://localhost:3000 to view it in the browser.
    The page will reload if you make edits.
    You will also see any lint errors in the console.

  6. After the development is complete you can build a production ready project by running the following command.

    yarn 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.

Licence

Distributed under the GPL 3.0 License. See LICENSE for more information.