Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knighthacks/frontend_onboarding_project
https://github.com/knighthacks/frontend_onboarding_project
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/knighthacks/frontend_onboarding_project
- Owner: KnightHacks
- Created: 2023-09-08T09:21:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-27T21:27:09.000Z (about 1 year ago)
- Last Synced: 2024-05-29T17:14:27.874Z (6 months ago)
- Language: TypeScript
- Size: 104 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Frontend Onboarding Project
Welcome to the Frontend Onboarding Project! This project is designed to help you get up to speed with the technologies we use at KnightHacks.
## Getting Started
To get started, you'll need to install a few things. First, you'll need to install [Node.js](https://nodejs.org/en/). This will install Node Package Manager (npm) as well. Next, you'll need to install [Git](https://git-scm.com/) and [pnpm](https://pnpm.io/installation#using-npm). To install pnpm, run the following command:
```
npm install -g pnpm
```
Once you've installed these, you'll need to clone the repository. To do this, run the following command:
```
git clone https://github.com/KnightHacks/frontend_onboarding_project.git
```
Once you've cloned the repository, you'll need to install the dependencies of each project (frontend and backend). To do this, you'll need to change directories into each project and run the following command:
```
pnpm install
```
Next, you'll want to branch off of the main. This new branch should be named after you. To do this, run the following command:
```
git checkout -b
```
## Running the Project
For this project, you'll need to run both the frontend and backend. To do this, you'll need to open two terminals. In the first terminal, you'll need to change directories into the frontend project and run the following command:
```
pnpm run dev
```
In the second terminal, you'll need to change directories into the backend project and run the same command.
## Project Structure
The project is split into two parts: the client and the server. The client is built using [React](https://react.dev/), a frontend framework. The backend is built using [Fastify](https://www.fastify.io/), a Node.js framework. For more information, see the README.md in each project's directory.
## Submitting Your Project
Once you've completed the project, you'll need to submit it. Assuming you've pushed your branch to the remote repository, you'll need to create a pull request with your branch as the source and main as the destination. Once you've done this, ping Caleb on Discord and he'll review your project.