Girlscript Community Website

Contents

• Overview
• About the Project
• Technology Stack
• Getting Started with Frontend
• Contribution
• Contributors

Overview

• The GirlScript Foundation is a well-acclaimed organization working towards introducing newbies to tech.
• It has been successfully equipping modern youth with the new age technologies that are revolutionising the world today.

• It is a non-profit project brought to you by GirlScript Foundation to help beginners in the field of technology .

  ---

About the Project

The objective is to develop the GirlScript Community website from scratch.

This project is also listed as one of the projects of GirlScript Summer of Code 2021.

Check out the current version of the website at https://www.girlscript.tech.

This is how the final website should look like :

Technology Stack

• Frontend - React Js
• Backend - Django
• Database - MongoDb

Getting Started 👨‍💻

Setup the repository to your local environment.

1. fork the repository - Creates a replica of repository to your local environment.
2. Clone the repository using git clone https://github.com/girlscript/Girscript-Community-Website.git - Downloads all repo files to your machine.
3. cd Community-Website - Takes you to the root directory of the project.

Frontend ⚛️

Following are the steps to run the frontend of the community-website on your local. All the frontend code will go in the frontend directory.

1. Navigate to frontend folder using cd frontend.
2. Run npm install. It will install all the required packages and dependencies.
3. Run npm start to run the server.

4. Navigate to http://localhost:3000 to view it in the browser.

Contribution

This project is an Open source project. Anyone willing to contribute can take up an already opened issue or raise a new issue and work on it after getting assigned.

Contributors

Everyone is welcome to contribute. Please make sure to follow our guidelines mentioned at contribute.md