Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SlytherSavior authored Sep 23, 2024
1 parent edfb04b commit 7c9ad08
Showing 1 changed file with 33 additions and 45 deletions.
78 changes: 33 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,49 @@

# 🕸️ Weave Game Project

Welcome to the **Weave Game** project! This guide will help you get started with the codebase, install dependencies, set up your environment, and begin contributing to the project. Let's weave something awesome together! 🕹️

## 🚀 Getting Started
## 📖 Contributing

### Front-end Developers

If you're new to Next.js or open-source contributions, don’t worry! Follow the contribution guide [HERE](./CONTRIBUTION.md) to get started.

### 🚀 Getting Started

#### 1. Fork the Repository & Set Up the Repo Locally

Before you start, fork the repository to your GitHub account and clone it locally.
Not sure how to fork and clone? [Check out this guide](https://www.youtube.com/watch?v=nT8KGYVurIU) or this [GitHub Desktop tutorial](https://www.youtube.com/watch?v=UGokwtIn1Hk).

#### 2. Install Dependencies

### Install Dependencies
Run one of the following commands to install the required packages:
After cloning, install the required packages using one of the following commands:
```bash
npm install
or
yarn install
or
pnpm install
or
bun install
bun install
```
### Set Up Environment Variables
#### 3. Set Up Environment Variables

Copy the `.env.example` file to `.env.local`. Here's a sample of what your `.env.local` should look like:
```
AUTH_SECRET="" # Added by `npx auth`. Learn more: [Auth.js CLI](https://cli.authjs.dev)
AUTH_GOOGLE_ID="CLIENT_ID_GOOGLE"
AUTH_SECRET="" # Added by npx auth. Learn more: Auth.js CLI
AUTH_GOOGLE_ID="CLIENT_ID_GOOGLE"
AUTH_GOOGLE_SECRET="CLIENT_SECRET_GOOGLE"
FIREBASE_PROJECT_ID="FIREBASE_PROJECT_ID"
FIREBASE_CLIENT_EMAIL="FIREBASE_CLIENT_EMAIL"
FIREBASE_PROJECT_ID="FIREBASE_PROJECT_ID"
FIREBASE_CLIENT_EMAIL="FIREBASE_CLIENT_EMAIL"
FIREBASE_PRIVATE_KEY="FIREBASE_PRIVATE_KEY"
```
To generate a random `AUTH_SECRET`, simply run:

```bash
npx auth
```
### Run the Development Server

#### 4. Run the Development Server

Once your environment variables are set, you can start the development server using one of these commands:
```bash
Expand All @@ -43,29 +53,8 @@ yarn dev
or
pnpm dev
or
bun dev
bun dev
```
## 📖 Contributing

New to open-source contributions? No worries! Follow these steps to start contributing:

### Fork the Repository & Create a Pull Request

Check out this [guide on creating a fork and submitting a pull request](https://www.youtube.com/watch?v=nT8KGYVurIU). It covers the entire process!

### Set Up the Repo Locally

If you're new to GitHub Desktop, this [tutorial](https://www.youtube.com/watch?v=UGokwtIn1Hk) will help you set up and clone the repo.

### Contribute to this project
#### Front-end Developers

See the contribution guide [HERE](./CONTRIBUTION.md)

### Submit Your Changes

After making your contributions, push them to your fork and submit a pull request. 🎉

## 🛠️ Tech Stack

This project uses the following technologies:
Expand All @@ -74,19 +63,18 @@ This project uses the following technologies:
- **Auth.js** 🔐: Authentication solutions like Google OAuth.
- **Firebase** 🔥: Backend for managing authentication, real-time data, and more.

## 🧑‍💻 Useful Commands :
## 🧑‍💻 Useful Commands

- **Install Dependencies:**
- **Install Dependencies:**
```bash
npm install
or
yarn install
npm install
or
yarn install
```
- **Start Development Server:**
- **Start Development Server:**
```bash
npm run dev
or
yarn dev
npm run dev
or
yarn dev
```

Feel free to explore, jump in, and contribute! Happy coding! 😎

0 comments on commit 7c9ad08

Please sign in to comment.