![Logo](assets/logo.png)
From pulling an all-nighter project for school, to adding some more features.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.
Here's why:
- Your time should be focused on creating something amazing. A project that solves a problem and helps others
- You shouldn't be doing the same tasks over and over like creating a README from scratch
- You should implement DRY principles to the rest of your life 😄
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!
Use the BLANK_README.md
to get started.
This project was developed using the MERN (MongoDB, Express.js, React, Node.js) stack, along with several other essential technologies and tools.
Some Features of this project.
- User Creation
- Form Creation
- Viewing Results
This project have two parts, backend and frontend.
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
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Clone the repo
git clone https://github.com/milanb0z/forms-manager.git
- Install NPM packages
npm install
- Create Environment Variables
.env
PORT=3001 MONGO_URI=<MONGO_DB_URL> JWT_SECRET=<JsonWebToken Secret> NODE_ENV=development
- Run Server
npm start
- Enter /client folder
cd client
- Install NPM packages
npm install
- Run App
npm run dev
- View app Here
- Add Open/Close Form
- Add Custom Link for From
- Add Multiple Types of question
- Chinese
- Spanish
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
milanb0z - @milanb0z - [email protected]
Project Link: https://github.com/milanb0z/forms-manager
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!