/Top_Secrets

This is a website that allows user to add their secrets anonymously to the website. Thus makes its interesting. One can add their secrets that they don't want to share with anyone.

Primary LanguageEJSMIT LicenseMIT

License Repo Size TOP_LANGUAGE FORKS Stars

Join the discord server for more discussion:

Top_Secrets

This is a website that allows user to add their secrets anonymously to the website. Thus makes its interesting. One can add their secrets that they don't want to share with anyone.

Technologies

  • HTML
  • Javascript
  • CSS
  • Bootstrap
  • Nodejs
  • Expressjs
  • MongoDB

Project Setup

First time setup

git clone https://github.com/Kritika30032002/Top_Secrets.git

Running the app locally 💻

Following are the steps to run the backend of the community-website on your local.

Installation

Top_Secrets has a single installation step:

  1. Install the dependencies: Install all the required packages and dependencies.
npm install

Ps: if you're getting error installing the dependencies, try --force command along with npm install. For example

npm install --force

Create a .env file in the root directory

-Refer to this video for google id and secret key : https://www.youtube.com/watch?v=XiuA-xO5Pz8
-Refer to this video for facebook id and secret key: https://www.youtube.com/watch?v=LLlpH3vZVkg&t=258s

  • paste these line in the .env file and update with your respective values:
GOOGLE_ID=<YOUR GOOGLE ID>
GOOGLE_SECRET=<YOUR GOOGLE SECRET KEY>
FACEBOOK_APP_ID=<YOUR FACEBOOK APP ID>
FACEBOOK_APP_SECRET=<YOUR FACEBOOK SECRET KEY>

Now you're ready to run the app locally and sign into your local instance! You've now finished installing everything! Let's start 💯

Now you're ready to run the app locally and sign into your local instance!
  1. To Start the development server run
node app.js

Or if you have nodemon installed on your system , run

nodemon app.js
  1. Click here to see the backend server runing in the browser OR navigate to
http://localhost:3000

Start the servers

How to get started with Open Source

Here's a quick run down on how to get started with open source, first of all let's know some basic terminologies:

  • Git: is a versioning system that let's you store your code and code history on your local computer preventing loses and allowing sharing of that code
  • Github: is a server that let's you store the history in a database
  • Open Source: A project is said to be open sourced if you can see the code on GitHub
  • Fork: This is a copy that you make of a project on GitHub, it gets added to your repositories
  • Repository: A project on GitHub is called a repository
  • Pull Request: This is a fix for an issue proposed to be done in a project, this consists of you editing a file in the project.
  • Issue: An issue is a change that should be done in a project, can be a bug, a new feature or a suggestion to a project
  • Branch: A branch is a new workspace derived from the default workspace(main or master), it allows you to work on something without affecting the original code.
  • Star: When you star a repositiory, it gets saved at your profile and you can easily re-visit it later.

Now you know some basic terms, let's get into how to get started with some resources to let you understand open source better:

Contributing

I heartily welcome any and all contributions that match our engineering standards! 🙌

That being said, this codebase isn't your typical open source project because it's not a library or package with a limited scope—it's our entire product.

  • Contributions make the open source community such an amazing place to learn, inspire, and create.
  • Any contributions you make are greatly appreciated.
  • Check out our contribution guidelines for more information.

Don't forget to leave a star✨

HAPPY CONTRIBUTING!!

🥂 After making a change

  1. Create a new branch
git checkout -b YourBranchName
  1. Add it to staging area
git add <path to the file you worked on>
  1. Commit your changes with
git commit -m "message"
  1. Push your changes
git push

Rules

  • No console.logs in any file: We use the debug module across the codebase to log debugging information in development only. Never commit a file that contains a console.log as CI will fail your build. The only exceptions are errors, which you can log, but you have to use console.error to be explicit about it
  • Code reviews: All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.

Reporting a bug or discussing a feature idea

If you found a technical bug on the website or have ideas for features we should implement, the issue tracker is the best place to share your ideas. (click here to open a new issue)

Fixing a bug or implementing a new feature

  • If you find a bug on Project and open a PR that fixes it we'll review it as soon as possible to ensure it matches our engineering standards.
  • If you want to implement a new feature, open an issue first to discuss what it'd look like .
  • If you want to contribute but are unsure to start, we have a "good first issue" label which is applied to newcomer-friendly issues and pick something you like!
  • Want to fix a bug or implement an agreed-upon feature? Great, jump to the local setup instructions!

Demo Video of Website

screen-capture.webm

Thanks to all Contributors 💪

Thanks a lot for spending your time helping Top_Secrets to grow. Thanks a lot! Keep rocking 🍻 Also Give it a Star 🌟, If you loved contributing to the project.

License

MIT License, see the LICENSE file.