Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 1.9 KB

README.md

File metadata and controls

65 lines (44 loc) · 1.9 KB

Commonsense Platform

Description

This project is a web application built using Express.js and React. It serves as a platform for users to complete a common sense survey. The application allows users to answer survey questions and provides an interactive interface for collecting and analyzing survey data.

Goals and Vision

The primary goal of the platform is to create an online space where individuals can actively contribute to the Common Sense project. Users are encouraged to participate in surveys and provide valuable data that contributes to the understanding of common sense.

Getting Started

To run the application locally, follow these steps:

  1. Clone the repository:
git clone https://github.com/Watts-Lab/Commonsense-Platform.git
  1. Install the dependencies for the frontend and backend:
cd Commonsense-Platform
cd client
npm install
cd ../server
npm install
  1. Configure the backend:
  • Create a MySQL database and update the database configuration in the server's config.json file.
  • Run database migrations to create the necessary tables:
npx sequelize-cli db:migrate
  1. Start the development servers:

Start the backend server:

npm run dev

Start the frontend development server:

cd ../client
npm run dev
  1. Access the application in your browser at http://localhost:5173.

Contributing

Contributions to this project are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request. Make sure to follow the project's code of conduct.

License

This project is licensed under the MIT License.

Contact

For any inquiries or questions, you can reach out to the project maintainers: