Survey

Survey is an innovative platform designed to create, publish, and manage surveys seamlessly. Whether you need to collect feedback, conduct market research, or gauge customer satisfaction, this project offers a streamlined solution to distribute surveys to your target audience.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Getting Started with Docker
   • Getting Started without Docker
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Key features

• Easy Survey Creation: Intuitive interface for building custom surveys with various question types.

• Survey Publishing: Publish surveys and share them via public or private links.

• Real-time Response Tracking: Monitor survey results as they come in with instant updates.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• Docker(Optional)

If you prefer using Docker, ensure Docker is installed and running on your machine. You can download it from Docker's official website.

Getting Started with Docker

1. Clone the repo

   git clone https://github.com/NgYiKai/survey-laravel.git

2. Navigate to the project director and copy the .env.example file to create your .env file

    cp .env.example .env

3. Run docker compose

   docker compose up
   

4. Open a shell session inside container

   Replace laravel_app with the actual name of your Docker container, if different

   docker exec -it laravel_app sh
   

5. Generate the application key inside container

   php artisan key:generate

6. Run the database migrations inside container

   php artisan migrate
   

7. Install dependencies for frontend

   Navigate to the /react directory and install the required dependencies via npm

   npm install
   

8. Set up your environment variables

   Copy the .env.example file to create your .env file

    cp .env.example .env

   Update the .env file, the VITE_API_BASE_URL= should point to your server

9. Start the development server

   npm run dev
   

Getting Started without Docker

1. Clone the repo

   git clone https://github.com/NgYiKai/survey-laravel.git

2. Install dependencies for backend

   Navigate to the project directory and install the required PHP dependencies via Composer

    composer install

3. Set up your environment variables

   Copy the .env.example file to create your .env file

    cp .env.example .env

   Update the .env file with your specific settings, especially your database credentials

4. Generate the application key

   php artisan key:generate

5. Run the database migrations

   php artisan migrate
   

6. Start the development server

   php artisan serve    
   

7. Install dependencies for frontend

   Navigate to the /react directory and install the required dependencies via npm

   npm install
   

8. Set up your environment variables

   Copy the .env.example file to create your .env file

    cp .env.example .env

   Update the .env file, the VITE_API_BASE_URL= should point to your server

9. Start the development server

   npm run dev
   

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Improve server side logging
• Improve client side error handling
• Implement view answer page

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ng Yi Kai - ykng0508@gmail.com

Project Link: https://github.com/NgYiKai/survey-laravel

(back to top)