✌ We just got upgraded to V2.🎉

Check here at: https://alexadevhub.netlify.com

Alexa Blogs

The website is dedicated to Alexa Development blogs.:computer:
Blogs are posted by the members of Alexa Community:people_holding_hands:, Jaipur.

Stats

Issues :

Pull requests :

Commit history :

Stack Used: MERN.

The website stands on the MERN architecture.
You can find the front-end part within the client folder.

Development Guidelines

We have shifted our codebase from Heroku to Netlify and now have decoupled Backend and Frontend branches. This helps us to maintain code more easily. We follow modular coding practices.

Note

Frontend is hosted on Netlify.

Backend is on Heroku.

1. All changes regarding FrontEnd should be made in master. For contributors, if you are working on frontend, you need to send PR on master branch.
2. All changes regarding BackEnd should be made in v1-deployment. For contributors, if you are working on backend, you need to send PR on v1-deployment branch.

[IMPORTANT] Maintainers, DO NOT merge these two branches master and v1-deployment. This would lead to kill of application.

Steps to get you started:

1. Work on FRONTEND ONLY.
2. Work on BACKEND ONLY.
3. Work on (FRONTEND + BACKEND).

🧑‍🎨 FOR WORKING ON THE FRONTEND ONLY (Client Side)

Before moving forward, make sure you are aware of the MERN stack and have the necessary libraries and packages installed.
React is built using the create-react-app package for your knowledge.

• If you want to start learning React go through the documentation

Follow these steps to run the website locally.

• Clone the repo using terminal, giving this command git clone https://github.com/alexa-dev-hub/alexa-community-jaipur.git.
• Here you would be on the master branch already.
• Go inside client folder. cd client.
• Run npm install.
• Run npm start.
• Should run on http://localhost:3000.
• The backend APIs being hit are already hosted on Heroku and you need not to setup your server locally. With the above steps you are good to go.
• Make changes and updates.
• Make a PR to master.

🧑‍🔧 FOR WORKING ON THE BACKEND ONLY (Server Side)

Follow these steps to run the Server locally.

• Clone and browse to the project's directory.
• Switch Branch to v1-deployment by git checkout origin/v1-deployment.

Before moving to the next steps, first put up the MONGO_DB_URI.

• Inside the config folder, add a file named devkeys.js.
• Add this code.

const MONGO_DB_URI =
  "mongodb+srv://<username>:<password>@ecomerce-website.qfwmi.mongodb.net/<dbname>?retryWrites=true&w=majority";

module.exports = { MONGO_DB_URI };

• The above URI is just a sample. You will get a different URI when you connect your cluster to an application. It is advised you create new credentials and a new DB for working. You will then replace these details in the URI, namely < username >, < password > and < dbname >.
• Also make sure to whitelist your IP address in the cluster's Network Access Tab on MongoDB Atlas. You can allow traffic from all by putting in 0.0.0.0/0 too, for development purposes.

• Run npm install.
• Start with npm run server or npm run server-dev.
  This will start the server and you can test it using POSTMAN etc. to work and develop.

🧑‍🎨 + 🧑‍🔧 FOR WORKING ON FRONTEND + BACKEND

Follow the above steps to setup your environment to get started with the backend.

AFTER FORKING this repo, open two Terminals/CMD on your local machine.
One will run the frontend and the other will run the backend.

For Frontend, Clone the master branch, using:
$ git clone -b master --single-branch https://github.com/<username>/alexa-community-jaipur

For Backend, Clone the v1-deployment branch, using the following in the other terminal.
$ git clone -b v1-deployment --single-branch https://github.com/<username>/alexa-community-jaipur

Replace <username> with your GitHub Username.

Good for? :grinning:

The repository is good for beginners to work on. Those 👨‍💻 who have recently learnt React and Web development and want to get their hands dirty with some cool open source projects are always welcome. We would love to see your creativity here.

Further Development and Contribution 💬

The website requires a whole new fresher look. We would love to see your creativity and bring out the designer within you. You can spill your ideas using the Material UI library for React. We need designer who could create wireframes for the website.

Regarding Deployment to Production 🚀

The website has been enabled with automatic deployments on Heroku (Server Side from v1-deployments) and on Netlify (Client-side from master), make sure you do not leave any critical merge conflicts whenever you leave a PR.

Want to be a part of Alexa Community, Jaipur. 🤝

Follow us on
We will get in touch with you.

Facing Any Problem or need any Help? 🤔

Write us in issues section. We will try to solve your issue within 24 hours ⏳.

Show some ❤️ and ⭐ the repo to support the project! 🤩

This project is published and maintained under MIT License

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tarun Singh 💻 📖 📝	Abir 💻 📖 🚇	Sumanth Nidamanuri 💻	Hari Om Yadav 💻	Dhruv Kapur 💻	Garima Singh 📖	priyanshu0405 💻
Manoj Athreya A 🎨	harshal kaigaonkar 💻	Sophia 🎨	Beatriz Sopeña Merino 🎨 💻

This project follows the all-contributors specification. Contributions of any kind welcome!