GDG Algiers Website

The Repository for GDG Website made with Gatsby and Firebase


View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Project Structure
5. Contributing
6. License
7. Contact

About The Project

This is a repository of GDG Website that presents information about our community, our events, how to contact us and so on.

link to site: https://www.gdgalgiers.com

Built With

• Gatsby
• Firebase

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Before you begin you need to install nodejs and then install yarn and gatsby-cli

• Yarn

  $ npm install --global yarn

• Gatsby CLI

  $ npm install --global gatsby-cli

Installation

1. Clone the repo and cd to it

    $ git clone https://github.com/GDGAlgiers/GDG-website-2020.git 
    $ cd GDG-website-2020

2. Install the necessary dependencies for the project

    $ yarn install

3. Create .env file to put the project's environment variables there

    $ cp .env.example .env

   If you want to contribute, you will need the values of the environment variables. So feel free to contact us to get them.

Usage

1. Running The Gatsby Project

    $ gatsby develop 

Visit http://localhost:8000/ to view the app.

Project-Structure

    /src/
        --> components/ # This folder contains the components used in the project 
        --> constants/ # This folder contains some configurations and the used colors in the project 
        ---> content/  # This folder has files containing the content used in the different sections of the website
        ---> firebase/ # This folder contains Firebase configuration for the project
        ---> images/ # This folder contains all the images used in the project
        ---> pages/ # This folder contains all the pages components built in the project
        ---> services/ # This folder contains the messaging setup for the contact section
        ---> styles/ # This folder contains the stylesheets used in the project

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/githubName/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/githubName/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache License. See LICENSE for more information.

Contact

GDG Algiers - @gdg_algiers - [email protected]

Project Link: https://github.com/GDGAlgiers/GDG-website-2020