Skip to content

Commit

Permalink
add: setup script and contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
visrut-at-incubyte committed Sep 11, 2023
1 parent 557b230 commit 7b224a6
Show file tree
Hide file tree
Showing 6 changed files with 922 additions and 6,070 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
MONGODB_URI=mongodb://localhost:27017
SALT=kdjlsjflsjfaoesffdnfldsafasjeifjskfdlsfdjsl3982402sd
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,19 @@
- In my research, I came across findings indicating that traditional survey designs tend to lack engagement.
- I also discovered criticisms regarding online surveys, citing issues such as uninteresting content leading to negative respondent behavior, including speeding through questions, providing random responses, and reduced participant attention.
- These insights inspired me to develop a survey platform that aims to transform the survey-taking experience into an engaging and enjoyable one, all while maintaining an intuitive user interface.

## Contribution Guidelines

To contribute to this project, please follow these steps:

- **Docker**: If you haven't already, install Docker to manage containers.
- Run `npm run setup` to install all the dependencies and start mongodb container.
- Run `npm run dev` to start the development server.
- Run `npm run test` to run the tests.
- If you want to see database state, you can run `npm run db-ui`

## Tech Stack

- **MongoDB**: I chose MongoDB as the database due to its flexibility and user-friendliness for now it seems like a good fit for the project.
- [Next.js](https://nextjs.org/) with [DaisyUI](https://daisyui.com/) for the frontend.
- I am using [Mongoku](https://github.com/huggingface/Mongoku) to view the database state.
Loading

0 comments on commit 7b224a6

Please sign in to comment.