Skip to content

added some details about project setup #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tweniee wants to merge 3 commits into
base: master
Choose a base branch
from
Open

added some details about project setup #8

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f5df701
added some details about project setup
Tweniee Nov 27, 2023
a15d256
added start script
Tweniee Nov 27, 2023
2686ea9
added cd ./digitalhippo in readme
Tweniee Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,43 @@ Built with the Next.js 14 App Router, tRPC, TypeScript, Payload & Tailwind

## Getting started

To get started with this project, run
### 1. Fork and Clone the Repository

```bash
git clone https://github.com/joschan21/digitalhippo.git
Copy link
Copy Markdown

@ArnavK-09 ArnavK-09 Nov 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or alternativly you can add . dir at last of cmd!

Linked with : #8 (comment)

Copy link
Copy Markdown
Author

@Tweniee Tweniee Nov 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please provide more details? I'm having difficulty understanding what you're trying to convey.

Copy link
Copy Markdown

@ArnavK-09 ArnavK-09 Nov 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Umm using git clone
The new repo is created with the same directory name as repo name

The next step you r trying to npm install, but without entering into new repo Directory

This can be fixed by

  • Either entering into repo local dir using cd digitalhippo before npm I
  • Or, Copying repo locally in current directory (without creating new dir), using . (directory) param in git clone cmd

Status: You added it, good 👍

Copy link
Copy Markdown
Author

@Tweniee Tweniee Nov 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cd ./digitalhippo is better as its easy to understand

```

and copy the .env.example variables into a separate .env file, fill them out & and that's all you need to get started!
### 2. Change directory

```sh
cd ./digitalhippo
```

### 3. Install dependencies

```sh
npm install

This comment was marked as resolved.

Sign in to view

```

### 4. Copy .env.example to .env

```sh
cp .env.example .env
```

Note:Simply complete the fields in the .env file, and you're all set to begin!

### 5. Run the build command

```sh
npm run build
```

### 6. Run the development server

```sh
npm run start
```

## Acknowledgements

Expand Down