Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
DAG100 committed Mar 11, 2024
1 parent ad75f0a commit b06a3d3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 29 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/nextjs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
NEXT_PUBLIC_BASE_PATH: /student-search-new
steps:
- name: Checkout
uses: actions/checkout@v3
Expand Down
39 changes: 10 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,19 @@
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).
# Student Search IITK

## Getting Started
Now in Next.js!

First, run the development server:
This is a remake of the original Student Search (located [here](https://github.com/pclubiitk/student-search)) in Next.js. Student data is stored in a MongoDB Atlas cluster for (mostly) free. Various improvements have been made to the original, including:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
- Full PWA Support (making it cross-platform)

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
- Family Tree Integration (data provided by Counselling Service IITK)

You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
- Dark Mode

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
- Better Searching

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
## Credits

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

## Learn More

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

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

## 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.
- Krishnansh Agarwal

0 comments on commit b06a3d3

Please sign in to comment.