Skip to content
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.

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

[docs] Add Frontend Setup Documentation #105

Merged
merged 3 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
80 changes: 61 additions & 19 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,78 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started

First, run the development server:

### Pre-requisites

- Install Node/Npm (see [here](https://nodejs.org/en))
jsandinoDev marked this conversation as resolved.
Show resolved Hide resolved


### Local configurations


- Rename the `frontend/gostarkme-web/.env.example` file to: `frontend/gostarkme-web/.env`.



- Comment the content of the file `frontend/gostarkme-web/next.config.mjs`.


## Local Deployment

### Installing Dependencies

First, install the required packages:

```bash
cd gostarkme/frontend/gostarkme-web

npm install
```
### Running the Application


Once the dependencies are installed, start the development server:


```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun 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.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More
## Production Deployment


To learn more about Next.js, take a look at the following resources:
### Installing Dependencies

First, install the required packages:

```bash
cd gostarkme/frontend/gostarkme-web

npm install
```

- [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.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
### Build the Application
To create an optimized production build, run:

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
```bash
npm run build
```


### Serve the build
Start the production server:
```bash
npm run start
```


Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
2 changes: 1 addition & 1 deletion frontend/gostarkme-web/app/fund/[fundId]/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const FundDetailsPage = async ({ params }: { params: { fundId: string } }) => {
return (
<>
<Bounded className="px-60 text-lg">
<h2 className="font-bold">User's fund - {params.fundId}</h2>
<h2 className="font-bold">User&apos;s fund - {params.fundId}</h2>
<Divider />
<Fund message="I need some Starks to finish my project."></Fund>
</Bounded>
Expand Down