flushingtech / flushingtech.org

The Flushing Tech Website
https://flushingtech-org.vercel.app
MIT License
3 stars 2 forks source link

Flushing Tech Website

Welcome to the Flushing Tech website repository! This repo is dedicated to building a new website for the Flushing Tech Meetup Group. The group currently has a website (flushingtech.org) built in Svelte, but we are transitioning to Next.js and React. Additionally, we now have a designer and PM on the team and would like to apply a more cross-functional approach to build a more visually appealing and user-friendly website.

Table of Contents

  1. Background on the Group
  2. About the Project
  3. Future Features
  4. Installation
  5. Contributing
  6. Contact

Background on the Group

Flushing Tech is a group for people from any skill level interested in technology. The group hosts multiple events, including in-person and virtual "hackathon" events where people come together, brainstorm project ideas, and then work on those projects together. The group also currently has a virtual "office hours" event where people vote on tech discussion topics. The group has an active Discord page, and people sign up for events through Meetup. The group also has a GitHub where some of the group's projects are hosted.

About the Project

This website will be built using Next.js and React, aiming to serve multiple purposes:

Future Features

Our roadmap includes several exciting features:

Installation

To set up the project locally, follow these steps:

  1. Clone the repo

    git clone https://github.com/flushingtech/flushingtech.org.git
  2. Switch to your project directory

cd flushing-tech-website
  1. Install dependencies
npm install
# or
yarn install
# or
pnpm install
# or
bun install
  1. Run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Contributing

Now that you've cloned the repository, create a new branch: git checkout -b your-branch-name

Make and stage your changes. Commit Changes. When you're ready, you can push those changes with git push origin your-branch-name. Then you can come back over to GitHub to open up a Pull Request to merge your branch with the main branch!

Contact

If you have other questions about the group or the website, you can ask on Discord! Here's the invite link: https://discord.gg/xGgFcZknDR We have a specific channel for the website project - feel free to ask website-related questions there.