Skip to content
This repository has been archived by the owner on Aug 5, 2023. It is now read-only.

Latest commit

 

History

History
83 lines (50 loc) · 3.46 KB

readme.md

File metadata and controls

83 lines (50 loc) · 3.46 KB
Raw

Netlify Status.github/workflows/lint.ymlCodeQL

Denver Devs Website - denverdevs.org

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project.

Prerequisites

You'll need some familiarity with HTML/CSS/JavaScript to get to work within this repo. But, of course, knowing a bit of React helps too.

Outside of knowledge, you'll need Node & Yarn to run this - so if you don't have those set up on your machine, we recommend following the instructions found on this page: https://yarnpkg.com/getting-started/install. FYI, we're using Node 16.

Installing

Clone this directory into the area you want:

git clone https://github.com/Denver-Devs/denverdevs.org

Hop into the directory it's at:

cd denverdevs.org

Get the dependencies / node_modules installed:

yarn

Once that's done, and it could take just a bit, you'll want to copy the env example to your own .env file via:

Note! Do not modify the values in .env.example, these are all you need to get going, and the Supabase values are public. Never commit your actual .env file, which should be in the gitignore.

cp .env.example .env

Now let's get the Next.js server going with:

yarn dev

Next.js will spin up a server for you, watch the repo, and let you update code without refreshing. You should be able to see this at localhost:3000.

You shouldn't need access to Netlify or Supabase unless you have specific requirements for helping with either of those, and we'll give it out on a case-by-case basis.

Deployment

We deploy through Netlify. After you've worked up your changes/feature branch, submit a PR. From there, Netlify can create a deploy preview for us to check things out. Once it's approved, we'll merge it into main.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests to us.

Authors

See the list of contributors who participated in this project.

License

This project is under the MIT License - see the LICENSE.md file for details. You're welcome to use our code here, and feel free to reach out with any questions. Please don't take or use our logo/identity without asking us.

Acknowledgments

  • Appreciate the free tiers open on so many great tools out there - they're a lifesaver when it comes to non-profit community projects.
  • The admins & community of denverdevs.org, thanks for being here.
  • Also, thanks to PurpleDoor for the rad readme template.