Skip to content
Open
Show file tree
Hide file tree
Changes from 5 commits
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
30 changes: 30 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -174,20 +174,33 @@ Temporary Items
# Ignore all local history of files
.history
.ionide
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
<<<<<<< HEAD
.pnp.js
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/versions

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
<<<<<<< HEAD
.env.local
.env.development.local
.env.test.local
Expand All @@ -200,3 +213,20 @@ yarn-error.log*
# Support for Project snippet scope

# End of https://www.toptal.com/developers/gitignore/api/macos,linux,jetbrains,visualstudiocode
*.pem

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

# env files (can opt-in for committing if needed)
.env*

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
61 changes: 54 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](CODE_OF_CONDUCT.md)
[![Slack](.github/slack.svg)](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
[![License](.github/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
Expand All @@ -23,25 +24,71 @@ To Contribute to Keploy Student Program Website, please follow the following ste
git clone https://github.com/keploy/student-program

```
3. Install the required dependencies using:
3. Install pnpm package manager globally:
```
npm install
npm install -g pnpm
```
4. Install all the packages:
```
pnpm install

4. Once the required packages are installed, run the following command to host this project on localhost:
```
npm start
5. Once the required packages are installed, run the following command to build the HTML, CSS, Javascript files:
```
pnpm run build
```

5. Make the desired changes
6. Run this following command to start the application on localhost:
```
pnpm run start
```

(Alternatively you can use ``pnpm run dev`` to skip step 5, 6 and start a local dev environment.

7. Add, commit & push the changes, using:
7. Make your desired changes.

8. Add, commit & push the changes, using:

``` bash
git add .
git commit -m "changes you made in the project" #Please make sure to mention which issue is closed by these changes. You can also use "cz c"
git push
```

6. Before raising a PR, please sure to 'Fetch Upstream' to avoid conflicts with existing codebase.
6. Before raising a PR, please sure to 'Fetch Upstream' to avoid conflicts with existing codebase.
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).

## Getting Started

First, run 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/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.

## 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/app/building-your-application/deploying) for more details.
Loading