Setup Steps: Difference between revisions

From Seedbury Square
No edit summary
(code syntax and added setting user.name and user.email)
 
(7 intermediate revisions by 2 users not shown)
Line 10: Line 10:
== VSCode ==
== VSCode ==
=== Initial Setup ===
=== Initial Setup ===
# Run ''git config --global credential.helper store''. This will store your git credentials the next time you input them.
# Run <code>git config --global credential.helper store</code>. This will store your git credentials the next time you input them.
# Run <code>git config --global user.name "YOUR_NAME_HERE"</code> and <code>git config --global user.email "YOUR_EMAIL_HERE"</code>.
# Create a "Projects" folder inside the "Documents" Folder.
# Create a "Projects" folder inside the "Documents" Folder.
# Inside this folder, clone the Ksitropy repository.
# Inside this folder, clone the Ksitropy repository.
## Visit the repository in Gitea.
## Visit the repository in Gitea.
## Under Code, copy the HTTP link.
## Under Code, copy the HTTP link.
## Inside the "Projects" folder run ''git clone PASTE_HTTP_LINK_HERE''
## Inside the "Projects" folder run <code>git clone PASTE_HTTP_LINK_HERE</code>
# Create env.js file inside the api folder.
# Create env.js file inside the api folder.
# Paste ''module.exports = env = { group: 0, id: ‘dev0’}''
# Paste <code>export default { group: 0, id: 'dev0'};</code>
 
=== User Settings and Aliases ===
=== User Settings and Aliases ===
# Press control+shift+p and type 'Open User Settings (JSON)'.
# Press control+shift+p and type 'Open User Settings (JSON)'.
Line 35: Line 37:


=== Running the app with debugger ===
=== Running the app with debugger ===
# In the debugger, press the link to create a setup.json file.
# In the debugger, press the link to create a launch.json file.
# In that file, paste the code in [[setup.json code]].
# Press enter to select the default option (Node.js).
# In that file, paste the code in [[launch.json code]].
# In that folder, create another file named tasks.json and paste the code in [[tasks.json code]].
# In that folder, create another file named tasks.json and paste the code in [[tasks.json code]].


Line 47: Line 50:


You can find it in '''172.31.106.81:7474/browser/preview''', remember to bookmark it for easy access.
You can find it in '''172.31.106.81:7474/browser/preview''', remember to bookmark it for easy access.
The connection information can be found in envSettings.js under graphDatabaseSettings

Latest revision as of 18:18, 8 January 2026

Amazon Workspaces

Username and password provided by admin. This password also corresponds to "Keyring" password inside the workspace.

Gitea

Gitea is the issue tracking and version control interface used for development in Ksitropy.

To access gitea, enter the following in the browser of your choice: 172.31.108.186:3000 (remember to bookmark it for easy access).

Create an account (YOUR_INITIALS-seedbury), admin will invite you to Ksitropy repository.

VSCode

Initial Setup

  1. Run git config --global credential.helper store. This will store your git credentials the next time you input them.
  2. Run git config --global user.name "YOUR_NAME_HERE" and git config --global user.email "YOUR_EMAIL_HERE".
  3. Create a "Projects" folder inside the "Documents" Folder.
  4. Inside this folder, clone the Ksitropy repository.
    1. Visit the repository in Gitea.
    2. Under Code, copy the HTTP link.
    3. Inside the "Projects" folder run git clone PASTE_HTTP_LINK_HERE
  5. Create env.js file inside the api folder.
  6. Paste export default { group: 0, id: 'dev0'};

User Settings and Aliases

  1. Press control+shift+p and type 'Open User Settings (JSON)'.
  2. In the resulting file, paste global user settings json.
  3. In the terminal, run code ~/.bash_aliases
  4. In the resulting file, paste the bash aliases code.
  5. In the pasted code, insert your own Gitea token:
    1. Go to Gitea.
    2. Go to Settings -> Applications.
    3. Under Generate New Token:
      1. Input a token name of your liking.
      2. Check 'All (public, private, and limited)'.
      3. Under Select permissions, set all to 'Read and Write'.
    4. Click Generate Token button.
    5. Copy the token in the blue box.
    6. Paste in the bash aliases file where it says <get token in gitea> surrounded by quotes.

Running the app with debugger

  1. In the debugger, press the link to create a launch.json file.
  2. Press enter to select the default option (Node.js).
  3. In that file, paste the code in launch.json code.
  4. In that folder, create another file named tasks.json and paste the code in tasks.json code.

To run the development build, choose Dev: server + browser in the debugger and run it.

Create a Ksitropy account

In the development website, create an account using the work email and a password of your choice. Remember or write down these credentials. An admin will activate your account.

Neo4j

Neo4j is used to interact with the graph database that is used in Ksitropy.

You can find it in 172.31.106.81:7474/browser/preview, remember to bookmark it for easy access.

The connection information can be found in envSettings.js under graphDatabaseSettings