Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dantelentsoe/freelance-hub
This application allows freelances to log, clients and projects they have with clients
https://github.com/dantelentsoe/freelance-hub
apollo-client chakra-ui expressjs graphql monogodb nextjs nodejs typescript
Last synced: 1 day ago
JSON representation
This application allows freelances to log, clients and projects they have with clients
- Host: GitHub
- URL: https://github.com/dantelentsoe/freelance-hub
- Owner: DanteLentsoe
- Created: 2022-06-27T16:39:08.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-26T18:48:54.000Z (about 2 years ago)
- Last Synced: 2023-08-03T12:06:47.333Z (over 1 year ago)
- Topics: apollo-client, chakra-ui, expressjs, graphql, monogodb, nextjs, nodejs, typescript
- Language: TypeScript
- Homepage: freelance-hub.vercel.app
- Size: 434 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# freelance-hub
Freelance Hub is an application intented on aiding with administration and tracking of clients and projects associated with clients for freelancing as well as a small team managing mulitple projects.
The application features, a client (Next.js and TypeScript) and a graphql API (server with Express, MongoDB)
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- [MongoDBCompass](https://www.mongodb.com/try/download/compass) minimum v1.32
- [yarn](https://classic.yarnpkg.com/en/)npm i yarn
- [Node](https://nodejs.org/en/) minimum v12.3.0
### Installing
- Clone the repository using HTTPS
```
git clone https://github.com/DanteLentsoe/freelance-hub.git
```
```
cd freelance-hub
```
cp server/.env.example server/.env
# Set up your DB connection string using MONOGO_URI
cd server && yarn && cd ..
cd client && yarn && cd ..
cd server && yarn dev && cd ..
# Run Client
cd client yarn dev
- yarn start
Client Endpoint : http://localhost:3000
# Run Server
cd server yarn dev
- yarn start
Server Endpoint : http://localhost:8000/graphql
## Environments
There are 2 environments each corresponding to a branch on the repository:
- Production - `master` branch
- Development - `dev` branch
## Deployment
The application is deployed on [Repl.it](```https://.repl.it```)
## Built With
Details of the tech stack that has been used.
## Client
- [Typescript](https://www.typescriptlang.org/)
- [Nextjs](https://www.typescriptlang.org/)
- [ApolloClient](https://www.apollographql.com/docs/react/)
## Server
- [Node](https://nodejs.org/en/)
- [MonoDB](https://www.mongodb.com/)
- [GraphQl](https://graphql.org/)
- [Typescript](https://www.typescriptlang.org/)
## Architecture
A basic architecture diagram or description of the chosen architecture should be detailed here. Lol, I did not include it.
## File Structure/ Project Structure
Within the download you'll find the following directories and files:
```
freelance-hub/
├── client
│ ├──
│ ├──
│ ├──
│
|
|
|
├── server
│ ├── src
│ ├── config
│ ├── contants
│ ├── models
│ ├── schema
│ ├── index.ts
| ├── package.json
| ├── README.md
| ├── tsconfig.json
| ├── yarn.lock
```
## Authors
- **Dante Lentsoe**
## Licenses
```
├─ MIT: 953
├─ ISC: 78
├─ BSD-3-Clause: 37
├─ BSD-2-Clause: 29
├─ Apache-2.0: 26
├─ MIT*: 8
├─ BSD: 5
├─ (MIT OR CC0-1.0): 5
├─ CC0-1.0: 4
├─ WTFPL: 2
├─ Unlicense: 2
├─ 0BSD: 2
├─ Custom: https://github.com/tmcw/jsonlint: 1
├─ BSD-3-Clause OR MIT: 1
├─ (MIT OR Apache-2.0): 1
├─ CC-BY-4.0: 1
├─ Public Domain: 1
├─ AFLv2.1,BSD: 1
├─ (MIT AND Zlib): 1
├─ (MIT AND BSD-3-Clause): 1
└─ CC-BY-3.0: 1
```
## Meta
| Version | Author | Date |
| ------- | ----------------------------------- | ---------- |
| 0.0.4 | Dante Lentsoe | 05/07/2022 |