imterah/hermes
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 1 Packages Wiki Activity Actions

chore: better readme + package.json

Browse source
This commit is contained in:
dess 2024-04-21 21:07:53 -04:00
parent 31cbb1e264
commit d08acd32d5
No known key found for this signature in database
GPG key ID: 83A81C7EDCA26C0B
2 changed files with 24 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,2 +1,21 @@
# typescript-base
Base TypeScript template to use
<h1 align="center">NextNet</h1>
<p align="center">
<a href="https://builtwithnix.org"><img src="https://builtwithnix.org/badge.svg" alt="built with nix" height="20"/></a>
<img src="https://img.shields.io/github/license/greysoh/nextnet" alt="License Badge"/>
</p>
<br>
**NextNet is a dashboard to manage portforwarding technologies.**
<h2 align="center">Local Development</h2>
> [!NOTE]
> Using [nix](https://builtwithnix.org) is recommended. If you're not using Nix, install PostgreSQL, Node.JS, and `lsof`.
1. First, check if you have a working Nix environment if you're using Nix.
2. Run `nix-shell`, or alternatively `source init.sh` if you're not using Nix.
3. After that, run the project in development mode: `npm run dev`.
4. If you want to explore your database, run `npx prisma studio` to open the database editor.