Skip to content

Commit

Permalink
remove frontend folder
Browse files Browse the repository at this point in the history
  • Loading branch information
Firebird1029 committed Mar 16, 2024
1 parent d12b5d2 commit badb77b
Show file tree
Hide file tree
Showing 34 changed files with 103 additions and 102 deletions.
File renamed without changes.
36 changes: 35 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# Custom
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
File renamed without changes.
61 changes: 0 additions & 61 deletions README

This file was deleted.

70 changes: 67 additions & 3 deletions frontend/README.md → README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,70 @@
# README

## Installation

To install the backend Python packages:

```bash
cd api && pip install -r requirements.txt && cd -
```

To install the frontend NPM packages:

```bash
cd frontend && npm install && cd -
```

## Backend

To run the backend server:

```bash
cd api
flask --app server run --debug
```

To lint the backend code:

```bash
python -m pylint *.py
```

To access the local backend server:

```plaintext
http://127.0.0.1:5000/api/ping
```

## Frontend

To run the frontend application:

```bash
cd frontend
npm run dev
```

To lint the frontend code:

```bash
npm run lint
```

To access the frontend application:

```plaintext
localhost:3000
```

## Misc

To save a Python package to `backend/requirements.txt`, use `pigar`: `pip install pigar` then `pigar generate`.

## Next.js README

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
### Getting Started

First, run the development server:

Expand All @@ -20,7 +84,7 @@ You can start editing the page by modifying `app/page.js`. The page auto-updates

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
### Learn More

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

Expand All @@ -29,7 +93,7 @@ To learn more about Next.js, take a look at the following resources:

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel
### 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.

Expand Down
36 changes: 0 additions & 36 deletions frontend/.gitignore

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion frontend/package.json → package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.1.0",
"private": true,
"scripts": {
"flask-dev": "FLASK_DEBUG=1 pip3 install -r requirements.txt && python3 -m flask --app api/index run -p 5328",
"flask-dev": "pip3 install -r api/requirements.txt && python3 -m flask --debug --app api/index run -p 5328",
"next-dev": "next dev",
"dev": "concurrently \"npm run flask-dev\" \"npm run next-dev\" --kill-others",
"build": "next build",
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit badb77b

Please sign in to comment.