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.
MIT License
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.
To get started with locally running the app, follow these simple steps:
Clone this repository: Begin by cloning the Top Secrets repository to your local machine using the following command:
git clone https://github.com/Kritika30032002/Top_Secrets.git
Install the dependencies: Navigate to the cloned repository and install the required dependencies by running the following command:
npm install --force
Create a .env
file: Create a .env
file in the root directory of your project and add the following environment variables:
GOOGLE_ID=<YOUR GOOGLE OAUTH CLIENT ID>
GOOGLE_SECRET=<YOUR GOOGLE OAUTH SECRET KEY>
FACEBOOK_APP_ID=<YOUR FACEBOOK APP ID>
FACEBOOK_APP_SECRET=<YOUR FACEBOOK SECRET KEY>
PUBLIC_BASENAME=http://localhost:3000/
PORT=3000
MONGO_SERVER=mongodb://127.0.0.1:27017
GOOGLE_ID
& GOOGLE_SECRET
: Refer to this video for Google OAuth Client ID and Secret key : Click Here
FACEBOOK_APP_ID
& FACEBOOK_APP_SECRET
: Refer to this video for Facebook ID and Secret key: Click Here
PUBLIC_BASENAME
: The base URL for the Express app. For local setup, http://localhost:3000/
PORT
: The port on which the Express app is running.MONGO_SERVER
: The MongoDB URI. A MongoDB URI looks like the below examples. Check the video for local setup on Windows & Ubuntu. For a free cloud MongoDB database check this video.Locally running instance:
mongodb://127.0.0.1:27017/
Hosted on the internet:
mongodb+srv://<username>:<password>@somecluster.some.mongodb.net/
Run the project: Once you have installed the dependencies and added the required environment variables, you are ready to run the project. To start the development server, run the following command:
node app.js
or use nodemon
to run it in background for a detailed log & better development experience
npx nodemon app.js
Great you have successfully run the app! Now get coding!
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.
Here's a quick run down on how to get started with open source, first of all let's know some basic terminologies:
Now you know some basic terms, let's get into how to get started with some resources to let you understand open source better:
git checkout -b YourBranchName
git add <path to the file you worked on>
git commit -m "message"
git push
console.log
s 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 itIf 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)
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.
MIT License, see the LICENSE file.