Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
pheralb committed May 30, 2023
1 parent ab32f10 commit 758a4fc
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@

[**Sendcv**](https://sendcv.vercel.app) is a web app to explore jobs and create a beautiful profiles with your projects, social networks and experience. Inspired by [read.cv](https://read.cv/) ✨.

## 🤔 Features
## Features

- Explore & save offers using Infojobs API.
- Create a beautiful profile with your description, experience, projects & social networks.
- CMDK to navigate between pages.
- Light/dark theme.

## 🤔 Known issues

- [ ] Search job offers / users from the CMDK modal ([route](https://github.com/pheralb/sendcv/blob/main/src/components/search/index.tsx#L63)).
- [ ] Button to change the light/dark mode on the main sidebar. Server/client side rendering ([route](https://github.com/pheralb/sendcv/blob/main/src/components/changeTheme.tsx#L13)).
- [ ] Sometimes it does not show the tooltip in the sidebar ([route](https://github.com/pheralb/sendcv/blob/main/src/components/mainSidebar/sidebarItem.tsx#L20)).

## ⚙️ Stack

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):
Expand Down Expand Up @@ -62,12 +69,12 @@ pnpm install
pnpm postinstall

# with yarn:
yarn install
yarn install
```

**Setup environment variables**:

Create a ``.env`` file in the root folder of the project with the following variables:
Create a `.env` file in the root folder of the project with the following variables:

```env
# Prisma:
Expand All @@ -90,7 +97,7 @@ INFOJOBS_TOKEN=""
- [`DATABASE_URL`](https://planetscale.com/docs/tutorials/connect-nextjs-app#generate-a-connection-string) - Planetscale docs.
- [`GITHUB_CLIENT_ID` & `GITHUB_CLIENT_SECRET`](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) - Github OAuth docs.
- [`INFOJOBS_CLIENT_ID` & `INFOJOBS_CLIENT_SECRET`](https://developer.infojobs.net/app/manage-app/create.xhtml) - Create an app on Infojobs.
- [`INFOJOBS_TOKEN`](https://developer.infojobs.net/documentation/app-auth/index.xhtml) - In the *client credentials* section, enter the INFOJOBS_CLIENT_ID and the INFOJOBS_CLIENT_SECRET.
- [`INFOJOBS_TOKEN`](https://developer.infojobs.net/documentation/app-auth/index.xhtml) - In the _client credentials_ section, enter the INFOJOBS_CLIENT_ID and the INFOJOBS_CLIENT_SECRET.

**Open development server**:

Expand All @@ -104,7 +111,7 @@ npm run dev
pnpm dev

# with yarn:
yarn dev
yarn dev
```

2. Run to open Prisma Studio:
Expand All @@ -117,6 +124,9 @@ npm run studio
pnpm studio

# with yarn:
yarn studio
yarn studio
```

## 📝 License

- Distributed under the Apache License 2.0. See [`LICENSE`](https://github.com/pheralb/sendcv/blob/main/LICENSE).

1 comment on commit 758a4fc

@vercel
Copy link

@vercel vercel bot commented on 758a4fc May 30, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

sendcv – ./

sendcv.vercel.app
sendcv-git-main-pheralb.vercel.app
sendcv-pheralb.vercel.app

Please sign in to comment.