Welcome to Codeaon 👋💻

Live Website for Codeaon : Click Here!

Repository

A one-stop website for all developers and coders. This platform helps us to get all Youtube tutorials and articles for a certain topic in one place. This project proves to be a very handy and effective yet resourceful tool for learners.

Join Here

Join us to come up with a real-time platform to tackle the solution of needs of the individuals who are in situations of struggling to find proper resource to get started with and explore the coding world. We are building this app to ensure that no one suffers due to lack of awareness and get the required help when time matters a lot. Lets make this workflow more efficient and valuable to the community for their livelihood.

Tech Stacks

Node

Node installation on Windows

Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).
Node installation on Ubuntu

You can install nodejs and npm easily with apt install, just run the following commands.
```
$ sudo apt install nodejs
$ sudo apt install npm
```
Other Operating Systems

You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

$ node --version
v8.11.3

$ npm --version
6.1.0

If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

$ npm install npm -g

If you want to work on this unique project and share it with the world, you can do that here. Go through the contributing guidelines here.

Subsequently, also go through the GitHub documentation on creating a pull request.

Templates to Follow

Note : One should follow these templates while creating a new issue or pull request.

Folder Structure

Folder structure of this project for your reference

├── src
│   ├── cloudinary
│   ├── db
│   ├── middleware
│   ├── models
│   ├── routes
│   ├── app.js
│   
├── static
│   ├── assets
│   ├── js
│   ├── styles
│   │   ├── partials
|   ...
│   
├── views
│   │   ├── partials
|   ...
|
├── package.json
├── package-lock.json 
└── .gitignore
└── .env

Workflow:

Fork the repository
Clone your forked repository using terminal or gitbash.
Make changes to the cloned repository
Add, Commit and Push
Then in GitHub, in your cloned repository, find the option to make a pull request.

NOTE : For more details Click Here!

Installation

$ npm install

Running the project

$ npm start

Configure environmental variables

Create a .env file then edit it with your settings. You will need:

ENV=development
PORT=[your_port]
MONGO_URI=[your_mongo_uri]
JWT_SECRET=[your_jwt_secret]
EXPIRY=[your_jwt_expiry_time]
SECRET=[your_secret_for_mongostore]
CLOUDINARY_CLOUD_NAME=[your_cloudinary_cloud_name]
CLOUDINARY_KEY=[your_cloudinary_key]
CLOUDINARY_SECRET=[your_cloudinary_secret]
X_RAPIDAPI_HOST=[your_rapidapi_sendgrid_host]
X_RAPIDAPI_KEY=[your_rapiapi_sendgrid_key]
SENDGRID_EMAIL=[no-reply@your_domain.com]

console.log ( " Start contributing for Codeaon " );

Open Source Programs

_{KGEC Summer Of Code}

Valuable Contributors

Special thanks goes to all of the mentees who made a choice to make an impact. Contributions of any kind are welcome!🚀

Code Of Conduct

You can find our Code of Conduct here.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project Admin

Soujanya Hazra

Give this Project a Star

If you liked working on this project, do ⭐ and share this repository.

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉

srini047/Codeaon