diff --git a/docs/index.md b/docs/index.md index 010d8ae..b9336ae 100644 --- a/docs/index.md +++ b/docs/index.md @@ -27,39 +27,20 @@ Example `GET` request on the portal root ### Prerequisites -- [Node.js==22.x.x](https://nodejs.org/) +- [Node.js](https://nodejs.org/) - [PostgreSQL](https://www.postgresql.org/) -### Create Database - - $ CREATE DATABASE nick; - $ CREATE USER nick WITH ENCRYPTED PASSWORD 'nick'; - $ GRANT ALL PRIVILEGES ON DATABASE nick TO nick; - -### Bootstrap Installation - - $ yarn bootstrap - -## Development - -### Run backend - - $ yarn start - -### Testing +### Yeoman Generator - $ yarn test - -## Yeoman Generator - -If you want to create your own project and use Nick as a dependency you can use the Yeoman generator package for that. This way you are able to customize your project without making changes to the core of Nick. +If you want to create your own project using Nick you can use the Yeoman generator package. This way you are able to customize your project without making changes to the core of Nick. -### Installation +### Install dependencies -First, install [Yeoman](http://yeoman.io) and @robgietema/generator-nick using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)). +First, install [Yeoman](http://yeoman.io), @robgietema/generator-nick and [Yarn](https://classic.yarnpkg.com/en/) using [npm](https://www.npmjs.com/) (we assume you have pre-installed [Node.js](https://nodejs.org/)). $ npm install -g yo $ npm install -g @robgietema/generator-nick + $ npm install -g yarn ### Creating a new project @@ -67,14 +48,26 @@ First, install [Yeoman](http://yeoman.io) and @robgietema/generator-nick using [ This will bootstrap a new Nick project inside the current folder. +### Create Database + +Connect to the PostgreSQL console and create a database and a user with the correct permission using the following commands: + + $ CREATE DATABASE "my-nick-project"; + $ CREATE USER "my-nick-project" WITH ENCRYPTED PASSWORD 'my-nick-project'; + $ GRANT ALL PRIVILEGES ON DATABASE "my-nick-project" TO "my-nick-project"; + ### Boostrap the project -Create a database and a user with the correct permissions for your project (see above for details) and then bootstrap Nick with: +Bootstrap the project using the following commands: $ cd my-nick-project $ yarn bootstrap $ yarn start +### Testing + + $ yarn test + ## Contribute - Issue tracker: [https://github.com/robgietema/nick/issues](https://github.com/robgietema/nick/issues) diff --git a/site/index.html b/site/index.html index 74c62a1..5b89fd3 100644 --- a/site/index.html +++ b/site/index.html @@ -449,44 +449,15 @@
Nick uses Node.js 22.xNode.js and PostgresSQL - make sure you have both installed before installing Nick. To create - the database run the following SQL commands: -
-- - $ CREATE DATABASE nick; - $ CREATE USER nick WITH ENCRYPTED PASSWORD 'nick'; - $ GRANT ALL PRIVILEGES ON DATABASE nick TO nick; --
-
- Clone the
- repository
- and run the following command to bootstrap and start your
- application:
-
- - $ yarn bootstrap - $ yarn start --
-
- The rest api is now available at
- http://localhost:8080. If you want to run the Volto fronted follow the instructions in
- the README.md file in the frontend folder.
+ make sure you have both installed before installing Nick. Check out
+ the installation instructions to
+ get your own Nick website up and running.