Formalyze

This is a full-stack web application that uses artificial intelligence to generate survey questions and analyze user responses.

Table of Contents

• Technology Stack
• Getting Started
• Running the Application
• Git Commit Conventions
• Branching
• Pull Requests

Technology Stack

• Frontend: React
• Backend: Express/Node

Getting Started

1. Clone the repository:

   git clone https://github.com/shannon-jx/formalyze.git
   cd formalyze
   

2. Install dependencies for both client and server:

• Client (React):

  cd client
  npm install
  

• Server (Node.js):

  cd ../server
  npm install
  

Running the Application

1. Start the Backend Server

cd server
npm run dev

2. Start the Frontend Client

cd ../client
npm start

3. Open http://localhost:3000 to view the frontend in the browser.

Git Commit Conventions

• feat: Used when adding a new feature to the project
• fix: Used when fixing a bug
• docs: Used when updating documentation
• refactor: Used when refactoring code without changing its behavior
• test: Used when adding or modifying tests
• chore: Used for miscellaneous tasks

Branching

<name> / <type_of_change> / <description>

eg. tom/feat/home-page

Pull Requests

• Describe your Changes
• Issue(s) Fixed
• Things to Note
• Type of Change