Skip to content

Commit

Permalink
docs: change clone instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Dun-sin authored Dec 13, 2023
1 parent ca94e4d commit 4f8372b
Showing 1 changed file with 9 additions and 71 deletions.
80 changes: 9 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Attention: Whisper is currently under some heavy changes as we are converting the project to nextjs + typescript, somethings aren't in other yet
<div id="top"></div>

<div align="center">
Expand All @@ -24,53 +25,9 @@
This app is developed to make chatting much private and easy without stealing your data!!

### ✨ Built With

<table>
<tbody>
<tr>
<td align="Center" width="30%">
<a href="https://reactjs.org/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/react-colored.svg" width="36" height="36" alt="React" /></a>
<br>React
</td>

<td align="Center" width="30%">
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/javascript-colored.svg" width="36" height="36" alt="Javascript" /></a>
<br>JavaScript
</td>
<td align="Center" width="30%">
<a href="https://nodejs.org/en/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/nodejs-colored.svg" width="36" height="36" alt="NodeJS" /></a>
<br>NodeJS
</td>
<td align="Center" width="30%">
<a href="https://www.mongodb.com/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/mongodb-colored.svg" width="36" height="36" alt="MongoDB" /></a>
<br>MongoDB
</td>
<td align="Center" width="30%">
<a href="https://www.docker.com/" target="_blank" rel="noreferrer"><img src=".github/docker.png" width="36" height="36" alt="MongoDB" /></a>
<br>Docker
</td>
</tr>
</tbody>
</table>

<table>
<tbody>
<tr>
<td align="Center" width="30%">
<a href="https://socket.io/" target="_blank" rel="noreferrer"><img src="https://w7.pngwing.com/pngs/162/702/png-transparent-socket-io-node-js-express-js-npm-network-socket-github-angle-triangle-logo-thumbnail.png" width="36" height="36" alt="SocketIo"></a>
<br>SocketIo
</td>
<td align="Center" width="30%">
<a href="https://kinde.com/" target="_blank" rel="noreferrer"><img src="https://pbs.twimg.com/profile_images/1577508370189520896/zAvyayM9_400x400.jpg" width="36" height="36" alt="Kinde"/></a>
<br>Kinde
</td>
<td align="Center" width="30%">
<a href="https://tailwindcss.com/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/tailwindcss-colored.svg" width="36" height="36" alt="TailwindCSS" /></a>
<br>TailwindCSS
</td>
</tr>
</tbody>
</table>
- Next.js
- TypeScript
- Tailwind

### 🖼️ Screenshot

Expand Down Expand Up @@ -105,40 +62,21 @@ Before installation, please make sure you have already installed the following t
cd Whisper
```

4. Navigate to the respective client and server directory

```bash
cd client
```

```bash
cd server
```

5. Install dependencies with `npm install`
4. Install dependencies with `npm install`

```bash
npm install
```

6. Use `.env_sample` to configure the `.env` file for both client and server. For the server .env mongodb url use the localhost to test

5. Use `.env_sample` to configure the `.env` file. For the server .env mongodb url use the localhost to test
> Check this video of how to do that: https://www.youtube.com/watch?v=D0U8vD8m1I0
> Note: If using Docker, the MongoDB port is **27018**
7. Run npm start in the client directory and npm run dev:docker in the server directory, this uses docker for the server part

```bash
npm start
7. Run npm run dev.
```

```bash
npm run dev:docker
npm run dev
```

> For those who do not wish to use Docker, here is another option -> [to start the project](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md#starting-the-project-without-docker)
8. To test things out, you can open the same URL in two different browsers or open a private browsing window in the same browser. This allows you to connect to yourself, use `login anonymously` if you aren't dealing with anything that uses user data else use `login` and open an account on kinde `https://kinde.com/` following the instructions for react implementation and replace it with the data from your kinde.
8. To test things out, you can open the same URL in two different browsers or open a private browsing window in the same browser. This allows you to connect to yourself, use `login anonymously` if you aren't dealing with anything that uses user data else use `login`.

<p align="right">(<a href="#top">back to top</a>)</p>

Expand Down

0 comments on commit 4f8372b

Please sign in to comment.