Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sanam2405/sherlocked
A race against time to observe, decipher and unveil a mysterious case
https://github.com/sanam2405/sherlocked
Last synced: 19 days ago
JSON representation
A race against time to observe, decipher and unveil a mysterious case
- Host: GitHub
- URL: https://github.com/sanam2405/sherlocked
- Owner: sanam2405
- License: apache-2.0
- Created: 2024-02-27T07:48:37.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-17T22:25:06.000Z (9 months ago)
- Last Synced: 2024-04-17T23:31:15.753Z (9 months ago)
- Language: TypeScript
- Homepage: https://sherlocked.sanam.live
- Size: 23.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sherlocked
_A race against time to observe, decipher and unveil a mysterious case_
[Sherlocked - _Start Hacking Now_](https://sherlocked.manaspratimbiswas.com/)
## Sherlocking locally with Docker
- Starting all the services
```bash
docker compose up
```
- Connecting with the _Moriarty_ TCP server
```bash
nc localhost 3003
```
Start getting _Sherlocked_ at _**`localhost:5173`**_
## Setting up locally
The codebase is organized as :
1. _Irene Adler_ - The frontend
2. _Sherlock Holmes_ - The backend
3. _Watson_ - The deprecated backend
4. _Moriarty_ - TCP server for reverse shell
5. _git-automation_ - Scripts for generating _git logs_
- Clone the Sherlocked repository
```bash
git clone [email protected]:sanam2405/sherlocked.git
cd sherlocked
```
- Run the frontend
```bash
cd ireneadler
npm install
npm run dev
```
- Run the backend
```bash
cd sherlockholmes
npm install
npm run dev
```
For a clean build
```bash
cd sherlockholmes
npm install
npm run build
npm start
```
## Built with ♥️ by
- [Anurag Jha](https://www.linkedin.com/in/anurag-jha-600967225/)
- [Tanmay Roy](https://www.linkedin.com/in/roytanmay/)
- [Manas Pratim Biswas](https://www.linkedin.com/in/manas-pratim-biswas)