updated readme
This commit is contained in:
@@ -1,4 +1,63 @@
|
|||||||
# V2 - Attempt 2 
|
## Inventory++ 
|
||||||
|
|
||||||
|
WIP!
|
||||||
|
|
||||||
|
This is an application intended to ease the process of managing multiple online stores.
|
||||||
|
The benefits provided by this application will be to automatically manage shared inventory between stores,
|
||||||
|
reducing the amount of time needed to synchronize inventory between stores.
|
||||||
|
|
||||||
|
|
||||||
|
# Deploying
|
||||||
|
|
||||||
|
The application runs locally, from this directory.
|
||||||
|
It is deployed simply by running either from the root of the project,
|
||||||
|
```
|
||||||
|
make run
|
||||||
|
```
|
||||||
|
or
|
||||||
|
```
|
||||||
|
go run .
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# Development
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
There's a Makefile with a number of operations for running and testing the application
|
||||||
|
|
||||||
|
|
||||||
|
## Technology
|
||||||
|
|
||||||
|
### Languages
|
||||||
|
|
||||||
|
#### Server side
|
||||||
|
Golang, Go Templates,
|
||||||
|
|
||||||
|
#### Front end
|
||||||
|
HTML, CSS, Javascript
|
||||||
|
|
||||||
|
### Databases
|
||||||
|
Postgres, in docker
|
||||||
|
|
||||||
|
#### Management
|
||||||
|
Using [migrate](https://github.com/golang-migrate/migrate) to manage build out the database schema, and to run
|
||||||
|
migrations.
|
||||||
|
|
||||||
|
|
||||||
|
### Tooling
|
||||||
|
|
||||||
|
#### Server side
|
||||||
|
- github.com/angelbeltran/templater: for wiring up template directories for serving over the web and improving
|
||||||
|
the task of composing template together.
|
||||||
|
- go templates: generating html declaratively from the server.
|
||||||
|
- github.com/jackc/pgx/v5: for postgres db interfacing
|
||||||
|
|
||||||
|
#### Front end
|
||||||
|
- htmx: for strong hypermedia support
|
||||||
|
- hyperscript: for minimal, inline scripting, with strong integration with htmx
|
||||||
|
- tailwind: for styling the front end, using tried and testing styling paradigms, conventions, and templates.
|
||||||
|
>>>>>>> 16a3551 (updated readme)
|
||||||
|
|
||||||
|
|
||||||
# Roadmap
|
# Roadmap
|
||||||
|
|||||||
Reference in New Issue
Block a user