Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/note-vault/note-vault

"Note Vault" is a comprehensive note taking website designed with user’s productivity and organization in mind. This versatile platform enables users to create, edit, delete, search, and seamlessly organize their notes, providing an all-round solution to their note-taking needs.
https://github.com/note-vault/note-vault

ejs gssoc javascript open-source

Last synced: 24 days ago
JSON representation

Host: GitHub
URL: https://github.com/note-vault/note-vault
Owner: Note-Vault
Created: 2024-04-30T14:12:58.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-05-19T13:24:27.000Z (6 months ago)
Last Synced: 2024-05-19T14:07:23.748Z (6 months ago)
Topics: ejs, gssoc, javascript, open-source
Language: EJS
Homepage: https://note-vault-tkco.onrender.com/
Size: 3.35 MB
Stars: 26
Watchers: 0
Forks: 65
Open Issues: 58
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Note-Vault📝
Welcome to our project!👋
## Project Description
"Note Vault" is a comprehensive note-taking website designed with the users productivity and organization in mind. This versatile platform enables users to create, edit, delete, search, and seamlessly organize their notes, providing an all-around solution to their note-taking needs.

- Deployment Link : [Note-Vault](https://note-vault-tkco.onrender.com/)

## Features 🪶
- Create, Edit, Delete, Search, and Organize Notes

## Technologies Used ⚙️
- Frontend: HTML, CSS, JavaScript, Ejs
- Backend: Node.js, Express.js, MongoDB
- Version Control: Git, GitHub

# How to make a PR in our Project 🤔
If you are interested in this project how to start contributing:

1. Fork the repo.

2. After forking, clone the repo to your local machine.
To clone the repo to your local machine, run the following command in your terminal:

```bash
git clone https://github.com/Note-Vault/Note-Vault.git
```

3. Add a remote upstream to the original repo.
To add a remote upstream, run the following command in your terminal:

```bash
git remote add upstream https://github.com/Note-Vault/Note-Vault
```

4. Check the remotes for this repository.

```bash
git remote -v
```

5. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

```bash
git pull upstream main
```

6. Create a new branch.
To create a new branch, run the following command in your terminal:

```bash
git checkout -b
```

7. Make changes in source code.

8. Add your changes
To add your changes, run the following command in your terminal:

```bash
git add ...
```
9. Commit your changes.
To commit your changes, run the following command in your terminal:

```bash
git commit -m ""
```

10. Push your changes.
To push your changes, run the following command in your terminal:

```bash
git push origin
```

11. Create a PR ✅ .

__________________________________________________________________________________________________________________________________________________________________

## Alternatively Using GitHub Desktop🧑‍💻

1. Open GitHub Desktop and log in to your GitHub account.

2. Make sure you are on the "Current Repository" view. If not, go to "File" and select "Add Local Repository" to add your repository.

3. In the "Current Repository" view, ensure you are on the branch which you want to submit a pull request for. If you're not on the correct branch, use the "Branch" menu to switch to the correct branch.

4. Once you're on the correct branch, make your changes and commit them to the branch. You can do this by clicking the "+" button in the upper-left corner of the GitHub Desktop window, making your changes, and then entering a commit message.

5. After you've made your changes and committed them, click the "Push origin" button in the top-right corner of the GitHub Desktop window. This will push your changes to the remote repository on GitHub.

6. Now, go to the GitHub website, navigate to your fork of the repository, and you should see a button to "Compare & pull request" between your fork and the original repository, click on it.

7. On the pull request page, you can review your changes and add any additional information, such as a title and a description, that you want to include with your pull request.

8. Once you are satisfied with your pull request, click the "Create pull request" button to submit it.

**Note:** To create a pull request, you must have a fork of the original repository in your GitHub account and you must have made the changes in that forked repository.

## Usage 👀
To get started, simply clone the repository and open the `terminal` in your code editor.
- ```bash
npm install
```
- ```bash
npm start
```

2. Create new `.env` file and copy contents from `sample.env`
3. Give any string of your choice in `JWTSECRETKEY`

## Google Configuration for nodemailer
To generate App Password in your Google account settings
1. Go to your Google Account:
```
Visit myaccount.google.com.
```
2. Navigate to Security:

- On the left-hand side, click on "Security".

3. Find "Signing in to Google" Section:

- Under "Signing in to Google", ensure 2-Step Verification is turned on.

4. Generate App Password:

- `Once 2-Step Verification is enabled`, you will see an option for "App passwords".
If not available search it on top menu.
- Click on "App passwords".
You may need to re-enter your Google account password.
Select the app (e.g., "Mail") and device (e.g., "Windows Computer") for which you need the App Password.
- Click "Generate".
A 16-character password will be displayed. Copy this password.
- paste it in `.env` file as value of `PASS`

## MongoDB connection:

1. Connect MongoDB Compass:
Open MongoDB Compass and connect to the MongoDB server at mongodb://localhost:27017.
![image](https://github.com/Chelseasingla1/Note-Vault/assets/129886894/2c796637-752f-4a49-a7e9-ec8069eee5e4)
2. Click on Connect.
![image](https://github.com/Chelseasingla1/Note-Vault/assets/129886894/b75f1efe-4ada-40fd-afe5-167242ec37d0)
3. In terminal it would be mentioned as "Connected to MongoDB".
4. After database connection you can see database collections:(database name (NoteVault), collection name (notebooks , users)):
![image](https://github.com/Chelseasingla1/Note-Vault/assets/129886894/6f6d14ce-ce27-4abd-b41c-026585846614)

## Contributing 🧑‍💻
- Fork the repository.
- Create your feature branch: git checkout -b feature-name
- Commit your changes: git commit -am 'Add some feature'
- Push to the branch: git push origin feature-name
- Submit a pull request.

## 🤝 Our Contributors

Thank you for contributing to our project! We appreciate any contributions, whether it's bug fixes, new features, or documentation improvements.

We value the time and effort you put into contributing, and we look forward to reviewing and merging your contributions. Join us on this exciting journey of creativity and collaboration, and let your projects shine on NestOndc!

This Project is the part of

## License
This project is licensed under the [ISC License](LICENSE).

## Acknowledgements :)
We extend our heartfelt gratitude to the organizers of GSSoC for offering this invaluable platform to exhibit our talents and make meaningful contributions to the open-source community. Your efforts in fostering a collaborative environment for budding developers are commendable, and we are privileged to be a part of such an esteemed event. Thank you for providing us with the opportunity to showcase our skills and contribute to the advancement of open-source technology.

⭐ Don't forget to give us a star! ⭐