search

opensourceryclub / OpenSourcerySite

Open Sourcery's Website, written in React and Typescript
GNU General Public License v3.0
5 stars 6 forks source link

readme

Open Sourcery Logo

Open Sourcery Site

LIVE SITE

This repository contains the source code for Open Sourcery's public website.

Getting Started

If you are looking to get started contributing to this project, check out the Contributing section below.

Setup

Quick links:

Make sure you have node v12 or later installed. If you are not sure what version of node you are running or need help during installation please visit here.

This project also uses the Yarn package manager instead of NPM. You can download Yarn here. Please make sure you do not run npm install, otherwise any changes you make will not be accepted!

Setup

First, clone this repo, or your own fork if you plan on contributing. See the Contributing section for details.

# Enter the repo directory
cd OpenSourcerySite
# Install project dependencies
yarn
# Start the local development server, available at http://localhost:8000
yarn start

Contributing

Thank you for showing interest in contributing to our website! Contributions are more than welcome from anyone and everyone.

If you are looking for ways to contribute, check out the open issues, or ask a project maintainer in the Open Sourcery Discord.

If you are not a member of the Open Sourcery Github organization yet, you should fork this repository and develop on it. When your changes are done, submit a pull request and a maintainer will review your changes. If you are a member, make a branch for your feature and submit a pull request when you're ready. All changes and branches should be made off the dev branch - the master branch is the production version of the site, and should not be used for development. Pull requests submitted to master will not be merged.

License

Copyright (c) 2019-2020 Open Sourcery. All Rights Reserved.

The source code for this site is licensed under the GNU GPLv3 or later.

The Open Sourcery logo in all of its forms is not licensed for public use. Please do not use our logo without written consent from a club administrator.

This site uses icons provided by FontAwesome. All brand icons are trademarks of their respective owners. The use of these trandemarks does not indicate endorsement of the trademark holder by Open Sourcery, nor vice versa.