Coder Social home page Coder Social logo

thegiraffe / alexa-community-jaipur Goto Github PK

View Code? Open in Web Editor NEW

This project forked from alexa-dev-hub/alexa-community-jaipur

0.0 1.0 0.0 3.39 MB

Source Code for Alexa Dev Hub Website - Website where we put up blogs related to Alexa Development and much more.

Home Page: https://alexadevhub.netlify.app/

License: MIT License

JavaScript 58.21% HTML 22.25% CSS 11.58% SCSS 7.96%

alexa-community-jaipur's Introduction

All Contributors

โœŒ 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

GitHub forks GitHub stars GitHub watchers GitHub license

Issues :

GitHub issues GitHub closed issues

Pull requests :

GitHub pull requests GitHub closed pull requests

Commit history :

GitHub commit activity GitHub last commit

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:

FOR WORKING ON THE FRONTEND ONLY (Client Side - REACTJS)

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 - NODE/EXPRESS/MONGO)

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.
  • This branch also has an outdated client folder. We recommend not to make changes to this, although you can run the whole app (outdated client + server) using npm run dev.

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 sumanth nidamanuri
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!

alexa-community-jaipur's People

Contributors

tarunnsingh avatar allcontributors[bot] avatar imabp avatar sumanthst24 avatar harshalkaigaonkar avatar manojathreya avatar thegiraffe avatar hariom1625 avatar beatrizsmerino avatar dkapur17 avatar garimasingh128 avatar priyanshu0405 avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.