Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 2.99 KB

README.md

File metadata and controls

87 lines (64 loc) · 2.99 KB

StartupDetroit

Welcome to StartupDetroit. This is an open source approach to building the Detroit Startup Community. Our goal is to tie together the greater Detroit startup community and be a central hub for startups and tech. Read on to learn how to contribute!

Join Slack Community

To join the Slack community go to https://startupdetroit.herokuapp.com/ to get an invite. This is managed thanks to a rauchg/slackin instance, hosted on Heroku.

How to Contribute

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

Feature requests, found a bug, or have an idea?

Create an issue

Want to add your startup or organization's logo?

You can:

Submit an issue titled "Add [Name] Logo". In the description, include:

  1. A link to your logo
  2. The city your org is based in (ex: Royal Oak, MI)
  3. Website link
  4. The type of supporter you are (Startup, Community Supporter, Investor)

Or, you can:

  1. Add the logo in the src/static/img/logos folder. Follow the naming convention of logo-[name].
  2. Import the logo in the src/components/Community.js file by adding this line at the top
import logoName from '../static/img/logos/logo-name.png';
  1. Add the logo in alphabetical order in the same file, as shown below.
<Logo
src={logoName}
location="Detroit, MI"
href="http://www.example.com"
name="Logo"
type="Startup, Community Supporter, or Investor"
/>
  1. Submit a pull request

Local Development

Getting started:

  • Download and install Yarn if you haven't already.
  • Run the following commands to clone the repository, install packages and launch in your browser
git clone https://github.com/startupdetroit/www
cd www
yarn install
yarn start

Build:

yarn run build

Deploy:

yarn run deploy

Technologies Used

Contributors