FormIt is a comprehensive project designed to simplify and streamline form creation, management, and data collection. This README provides an overview of the project, its features, and a step-by-step guide to set up and run FormIt on your local device.
- Features
- Tech Stack
- Project Structure
- Prerequisites
- Project Setup
- Running the Project
- Usage
- Screenshots
- Contributing
- License
- User-friendly form builder interface
- Create forms
- Edit forms
- Share forms with others to submit
- Submit forms shared by others
- View Responses
- Frontend: React.js
- Backend: Node.js, Express.js
- Database: MongoDB
- Styling: CSS
/FormIt
│
├── Backend/ # Backend source code
├── client/ # Frontend source code
├── README.md # Project documentation
└── ...
-
Clone the repository:
git clone https://github.com/Haseeb-U/FormIt.git cd FormIt
-
Install dependencies for backend:
npm run install-server
-
Install dependencies for frontend:
cd Backend npm run install-client
-
Create .env file:
- Go to backend folder
- Create a file named .env with following content
MONGO_DB_URL=#YOUR_MONGO_DB_URL_HERE MONGO_DB_NAME=#YOUR_MONGO_DB_NAME_HERE JWT_SECRET=#YOUR_JWT_SECRET_HERE
- Replace comments with your respective details
-
Start server:
cd Backend npm run dev
-
Access the application:
- Client server is running at
http://localhost:5173/
- Backend server is running at
http://localhost:5000
- Open your browser and navigate to
http://localhost:5173/
- Client server is running at
- Register or log in to your account.
- Create a new form.
- Add, remove, or customize fields as needed.
- Save or update form.
- Make your form public to share with others.
- Share your form.
- View collected responses.
Contributions are welcome! Please fork the repository and submit a pull request.
This project is licensed under the MIT License.
For any issues or questions, please open an issue on GitHub.