Merge pull request #27 from 51ngul4r1ty/tech/000307/move-common-deps-…

…to-root

Move Rollup Dependencies to Root `package.json`

.github/workflows/ci.yml

@@ -24,8 +24,10 @@ jobs:
           echo NPM Version
           npm --version
           echo
-      - name: Install NPM packages
+      - name: Install NPM packages (workspace)
         run: npm ci -ws
+      - name: Install NPM packages (root)
+        run: npm ci
       - name: Build API Types Package
         run: |
           echo Building...

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 build/*
-.DS_Store
+.DS_Store
+._*

CONTRIBUTING.md

@@ -0,0 +1,136 @@
+Overview
+========
+
+Everyone contributing to this repo should read this document before doing
+anything else: [Important](docs/Important.md)
+
+For specialized instructions with development related tasks (to save you time
+trying to do various things): [Dev HowTo](docs/Dev-HowTo.md)
+
+Many code standards and conventions can be picked up from existing patterns in
+the code but it is advisable to use this resource as well:
+[Code Standards](docs/Code-Standards.md)
+
+If you're looking for specific "Getting Started" instructions for any of the
+sub-projects in this monorepo (like the VS Code extension) then look at those
+specific README.md files.
+
+Requirements
+------------
+
+1. Node v18.19.0 (see `Running the App (using source code)` below)
+2. NPM v10.2.3
+3. PostgreSQL 16.3 for storing data:
+   `https://www.enterprisedb.com/downloads/postgres-postgresql-downloads`
+     (Windows 10 / Mac OS X)
+   `https://computingforgeeks.com/install-postgresql-12-on-ubuntu/`
+     (Ubuntu with links to other distros)
+4. VSCE v2.15.0 (for building VSIX file for VS Code extension)
+
+Recommendations
+---------------
+
+VS Code is the editor of choice for this project (v1.71.2 or newer).
+   - Make sure to install the recommended workspace extensions.
+
+Running the App (using source code)
+-----------------------------------
+
+1. Ensure the expected version of Node is active- you can use `nvm use` if you
+   have that installed or an equivalent method (use .nvmrc to see actual
+   supported version).
+2. Set up dependencies:
+   - at root level: `npm ci`
+3. Build the app:
+   - at root level: `npm run build-all`
+4. Set up PostgreSQL (you can use these steps or do it the way `setup.sql`
+   specifies - one inconsistency is "superuser" so it appears that it isn't
+   actually needed and either "y" or "n" will do):
+   - `sudo -u postgres createuser --interactive`
+     - role: `atoll`
+     - superuser: `n`
+     - allow to create databases: `y`
+     - allow to create new roles: `y`
+   - `sudo -u postgres psql`
+   - `\du` to see the user created
+   - `ALTER USER atoll PASSWORD '{pwd}'` (pick a password- you'll use this
+     later as well - `setup.sql` specifies `lim3atoll` but it is recommended
+     that you change this for security reasons!)
+   - `exit` (`\q` should work too)
+   - Restart PostgreSQL server
+     - Linux: `sudo service postgresql restart`
+     - Mac: `sudo -u postgres /Library/PostgreSQL/16/bin/pg_ctl -D /Library/PostgreSQL/16/data restart`
+   - `sudo -u postgres createdb atoll`
+     - if you see `could not change directory to ...` you can ignore that error
+   - `sudo -u postgres psql`
+   - `ALTER DATABASE atoll OWNER TO atoll;`
+   - `\p` to see that the command was executed (it will repeat the line above)
+   - `\q` to quit
+5. If you'd like to restore from a backup using pgAdmin 4, you can do that at
+   this step.  However, first time set up will require you to follow the
+   incomplete steps in `setup.sql` (up to, but not including, the "RUN THE APP"
+   step).
+6. Set up environment variables:
+   - set ATOLL_DATABASE_URL to the database connection string
+     (it should look something like this replacing "{pwd}" with
+      atoll user password: `postgres://atoll:{pwd}@localhost:5432/atoll`)
+   - set ATOLL_DATABASE_USE_SSL to "true".
+   - set ATOLL_AUTH_KEY to something unique for security reasons
+     (come up with an obscure value that doesn't follow a typical pattern-
+      you'll lever have to look this up so it can anything at all).
+7. Run the app to create the database structure:
+   - at root level: `npm start`
+   - watch the output
+   - if it was successful you'll see:
+     "Database & tables created!"
+   - kill the app (if you haven't restored from backup).
+8. Only needed if you've not restored from backup:
+   1. Setting up atoll user in database (not needed if you've restored from
+      backup):
+      - at root level: `npm run setup-database`
+      - if it was successful you'll see:
+        "Executed SQL statement to set up test user account successfully."
+   2. Set up sample data (not needed if you've restored from
+      backup):
+      - use pgAdmin or psql to execute the script `data.sql`
+   3. Run the app:
+      - at root level: `npm start`
+9. Verify that the app is running successfully:
+   - console output will have something like
+     `App is running: http://localhost:8500` at the start
+     so you know what URL to use in the browser.
+   - the sample script created a user with login `test` and password `atoll`, so
+     you should be able to use those credentials to login
+
+Running the App (using source code + Docker)
+--------------------------------------------
+
+1. At root level: `npm ci`
+2. Build app and create docker image: `npm run docker-pkg:web-app`
+3. Start docker containers using compose: `npm run start-docker:web-app`
+
+
+Working with the Monorepo
+=========================
+
+Adding Dependencies
+-------------------
+
+This monorepo uses npm workspaces.  If you're unfamiliar with using workspaces
+we recommend you read the npm documentation first.  Some tips are provided
+below, but it is best that you understand how they work fully.
+
+Please make sure to add the dependency at the right level.
+
+You have 2 choices:
+1. install it globally so that all packages can use that dependency (bear in
+  mind that they will use the exact same version when it is global).  
+  For example, `npm i prettier@latest -D`
+2. install it at the workspace package level so that individual packages can
+  either use a different version or not use it at all.  
+  For example, `npm i [email protected] -w packages/shared`
+
+In general, if you're not sure, you should pick option 2.
+
+If you wish to refresh packages for a specific workspace you can use something
+like: `npm i -w=packages/vscode-extension`

ISSUE.md

@@ -0,0 +1,12 @@
+{"status":500,"message":"targetItemPrevLink with 7045d122b3014d468849ad02a3decfc9 linked to self (which was source item)!"}
+
+curl 'https://pointswag.com/api/v1/actions/reorder-backlog-items' -X POST -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:124.0) Gecko/20100101 Firefox/124.0' -H 'Accept: application/json' -H 'Accept-Language: en-US,en;q=0.5' -H 'Accept-Encoding: gzip, deflate, br' -H 'Content-Type: application/json' -H 'Authorization: Bearer  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIyMTc3OTZmNmUxYWI0NTVhOTgwMjYzMTcxMDk5NTMzZiIsInVzZXJuYW1lIjoidGVzdCIsImV4cGlyYXRpb25EYXRlIjoiMjAyNC0wMy0xMVQxNzo0MjoyNy43MTBaIiwicm9sZSI6InVzZXIiLCJpYXQiOjE3MTAxNzg2NDd9.zQRYeJ5r5bMwEbUFoPBKuVKQe-3DR5VHD_sqcyvxshY' -H 'Origin: https://pointswag.com' -H 'Connection: keep-alive' -H 'Referer: https://pointswag.com/plan' -H 'Sec-Fetch-Dest: empty' -H 'Sec-Fetch-Mode: cors' -H 'Sec-Fetch-Site: same-origin' --data-raw '{"sourceItemId":"7045d122b3014d468849ad02a3decfc9","targetItemId":"028bec395df54b1f88578d444371e554"}'
+
+
+To repro the issue do this:
+
+1. Open one instance of Atoll in a browser (Firefox) window.
+2. Open another instance of Atoll in a different browser (Chrome) window.
+3. Drag the third backlog item to the top in the second brower.
+4. Drag the same third backlog item to the top in the first browser.
+5. It should blow up with this error.

README.md

@@ -14,126 +14,7 @@ adheres as closely to scrum best practices as possible.
 Getting Started (for Contributors)
 ==================================
 
-Everyone contributing to this repo should read this document before doing
-anything else: [Important](docs/Important.md)
-
-For specialized instructions (to save you time trying to do various things):
-[Dev HowTo](docs/Dev-HowTo.md)
-
-Many code standards and conventions can be picked up from existing patterns in
-the code but it is advisable to use this resource as well:
-[Code Standards](docs/Code-Standards.md)
-
-If you're looking for specific "Getting Started" instructions for any of the
-sub-projects in this monorepo (like the VS Code extension) then look at those
-specific README.md files.
-
-Requirements
-------------
-
-1. Node v18.19.0
-2. NPM v10.2.3
-3. PostgreSQL 12.2 for storing data:
-   `https://www.enterprisedb.com/downloads/postgres-postgresql-downloads`
-     (Windows 10 / Mac OS X)
-   `https://computingforgeeks.com/install-postgresql-12-on-ubuntu/`
-     (Ubuntu with links to other distros)
-4. VSCE v2.15.0 (for building VSIX file for VS Code extension)
-
-Recommendations
----------------
-
-VS Code is the editor of choice for this project (v1.71.2 or newer).
-   - Make sure to install the recommended workspace extensions.
-
-Running the App (using source code)
------------------------------------
-
-1. Set up dependencies:
-   - at root level: `npm ci`
-2. Build the app:
-   - at root level: `npm run build-all`
-3. Set up PostgreSQL (you can use these steps or do it the way `setup.sql`
-   specifies - one inconsistency is "superuser" so it appears that it isn't
-   actually needed and either "y" or "n" will do):
-   - `sudo -u postgres psql`
-   - `createuser --interactive`
-     - superuser: "n"
-     - allow to create databases: "y"
-     - allow to create new roles: "y"
-   - `\du` to see the user created
-   - `ALTER USER atoll PASSWORD '{pwd}'` (pick a password- you'll use this
-     later as well - `setup.sql` specifies `lim3atoll` but it is recommended
-     that you change this for security reasons!)
-   - `exit` (`\q` should work too)
-   - `sudo service postgresql restart`
-   - `sudo -u postgres createdb atoll`
-     - if you see `could not change directory to ...` you can ignore that error
-   - `sudo -u postgres psql`
-   - `ALTER DATABASE atoll OWNER TO atoll;`
-   - `\p` to see that the command was executed (it will repeat the line above)
-   - `\q` to quit
-4. Follow the incomplete steps in `setup.sql` (up to, but not including, the
-   "RUN THE APP" step)
-5. Set up environment variables:
-   - set ATOLL_DATABASE_URL to the database connection string
-     (it should look something like this replacing "{pwd}" with
-      atoll user password: `postgres://atoll:{pwd}@localhost:5432/atoll`)
-   - set ATOLL_DATABASE_USE_SSL to "true".
-   - set ATOLL_AUTH_KEY to something unique for security reasons
-     (come up with an obscure value that doesn't follow a typical pattern-
-      you'll lever have to look this up so it can anything at all).
-6. Run the app to create the database structure:
-   - `npm start`
-   - watch the output
-   - if it was successful you'll see:
-     "Database & tables created!"
-   - kill the app.
-7. Setting up atoll user in database:
-   - at root level: `npm run setup-database`
-   - if it was successful you'll see:
-     "Executed SQL statement to set up test user account successfully."
-8. Set up sample data:
-   - use pgAdmin or psql to execute the script `data.sql`
-9. Run the app to verify that everything is set up correctly:
-   - at root level: `npm start`
-   - console output will have something like
-     `App is running: http://localhost:8500` at the start
-     so you know what URL to use in the browser.
-   - the sample script created a user with login `test` and password `atoll`, so
-     you should be able to use those credentials to login
-
-Running the App (using source code + Docker)
---------------------------------------------
-
-1. At root level: `npm ci`
-2. Build app and create docker image: `npm run docker-pkg:web-app`
-3. Start docker containers using compose: `npm run start-docker:web-app`
-
-Working with the Monorepo
-=========================
-
-Adding Dependencies
--------------------
-
-This monorepo uses npm workspaces.  If you're unfamiliar with using workspaces
-we recommend you read the npm documentation first.  Some tips are provided
-below, but it is best that you understand how they work fully.
-
-Please make sure to add the dependency at the right level.
-
-You have 2 choices:
-1. install it globally so that all packages can use that dependency (bear in
-  mind that they will use the exact same version when it is global).  
-  For example, `npm i prettier@latest -D`
-2. install it at the workspace package level so that individual packages can
-  either use a different version or not use it at all.  
-  For example, `npm i [email protected] -w packages/shared`
-
-In general, if you're not sure, you should pick option 2.
-
-If you wish to refresh packages for a specific workspace you can use something
-like: `npm i -w=packages/vscode-extension`
+See [Contributing Guide](./CONTRIBUTING.md) for detais.
 
 Document Index
 ==============