https://github.com/ubclaunchpad/lp-website
UBC Launch Pad knowledge base
https://github.com/ubclaunchpad/lp-website
docs documentation handbook resources ubc
Last synced: about 1 year ago
JSON representation
UBC Launch Pad knowledge base
- Host: GitHub
- URL: https://github.com/ubclaunchpad/lp-website
- Owner: ubclaunchpad
- Created: 2016-12-03T22:35:15.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T23:16:12.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T04:09:30.111Z (almost 2 years ago)
- Topics: docs, documentation, handbook, resources, ubc
- Language: TypeScript
- Homepage: https://www.ubclaunchpad.com
- Size: 19.5 MB
- Stars: 8
- Watchers: 26
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# UBC Launch Pad Landing Page
This is the landing page for UBC Launch Pad, the leading student-run software engineering club at the University of British Columbia.
## Contributing
We appreciate any contributions to our docs. To contribute, please follow the steps below:
1. Check out the [issues](https://github.com/ubclaunchpad/LP-website/issues) to see if there are any open issues that you would like to work on.
2. If you find an issue that you would like to work on, assign yourself to the issue; if you want to contribute to an issue that is not listed, please create a new issue.
### Contributing to the Codebase
1. Fork the repository.
2. Clone the forked repository to your local machine.
3. Create a new branch for your changes.
4. Follow the instructions in the [Getting Started](#getting-started) section to set up the project.
5. Commit your changes.
6. Push your changes to your forked repository.
7. Create a pull request to the `main` branch of the original repository. Make sure to reference the issue you are working on in the pull request description.
## Getting Started
### Tech Stack
- This is a [Next.js](https://nextjs.org/) project with [TypeScript](https://www.typescriptlang.org/), [Tailwind CSS](https://tailwindcss.com/), and [ESLint](https://eslint.org/).
- [ESLint](https://eslint.org/) for linting and formatting.
- [Tailwind CSS](https://tailwindcss.com/) for styling. However, not limited to it.
- [PNPM](https://pnpm.io/) for package management.
- This project uses `next/font` to automatically optimize and load Inter, a custom Google Font, for the best performance.
### Installation
First, make sure you have [Node.js](https://nodejs.org/) installed on your machine.
To check if you have Node.js installed, run the following command in your terminal:
```bash
node -v
```
If you don't have Node.js installed, you can download it from [here](https://nodejs.org/).
Next, make sure you have [PNPM](https://pnpm.io/) installed on your machine.
To check if you have PNPM installed, run the following command in your terminal:
```bash
pnpm -v
```
If you don't have PNPM installed, you can follow the instructions [here](https://pnpm.io/installation).
Now, we can install the project dependencies.
```bash
pnpm install
```
### Running the Project
To start the development server, run the following command:
```bash
pnpm dev
```
Open [http://localhost:3000](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.
### Resources
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
- [Tailwind CSS Documentation](https://tailwindcss.com/docs) - learn about Tailwind CSS features and API.
- [TypeScript Documentation](https://www.typescriptlang.org/docs/) - learn about TypeScript features and API.
- [ESLint Documentation](https://eslint.org/docs/user-guide/getting-started) - learn about ESLint features and API.
- [PNPM Documentation](https://pnpm.io/docs/en/pnpm-cli) - learn about PNPM features and API.
- [React Documentation](https://reactjs.org/docs/getting-started.html) - learn about React features and API.