audrey/intranet
1
0
Fork 1
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

minor formatting changes

Browse Source
This commit is contained in:
Audrey Jensen 2023-08-09 19:24:07 +00:00
parent ce14e36c92
commit e30a17574a
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -10,10 +10,9 @@ Based on Symfony 6.3.3, a php framework for developing web applications.
It is cross-platform compatible, and can be run on Windows or Linux servers.
# Install
## Server Setup
(Optional, Recommended) Configuring Git
### (Optional, Recommended) Configuring Git
The recommended way to manage the app is through version-control software, such as Git. Git is recommended as it greatly simplifies continuous integration/development and provides a robust system for managing application versions.
In absence of a dedicated Git server (such as Gitlab or Github) a local install may be used. This is not ideal, however it probably is not worth running a dedicated system to serve git repositories unless we are maintaining multiple codebases.
This section will detail how to set up Git SCM for Windows using OpenSSH for communication.
This section will detail how to set up Git SCM for Windows.
> **WARNING!**
If you host the Git repo on the same machine as the application, you will need to make sure you’re keeping backups somewhere safe. If you don’t do this and data on the server is lost, the only other copies will be on development machines.
@ -22,17 +21,17 @@ If you host the Git repo on the same machine as the application, you will need t
Imagine our repository as a tree. The trunk is our ‘origin’, or master upstream branch, from which everything branches off.
Each ‘branch’ in the tree organizes groups of changes to the origin. The leaves on these branches represent individual changes to files. A leaf may be a change to a specific line, or a whole new file.
#### Definitions
Git: Version-control software used frequently to track history & manage changes to files. Most commonly used in software development.
Working Tree: A tree-graph of changes made to tracked files.
Tracked files: any file that is being monitored by Git.
Branch: Collections of changes. Branches may have branches of their own, which can each contain differing versions of the same file.
Merge: The process of merging changes from one branch to another.
Remote: A repository other than the local that changes are synced to. A local repo may have multiple remotes.
Upstream: Typically refers to an item on the remote that the local copy is based on.
Downstream: Refers to items that are based on this. The production & development clones are all downstream from the Remote.
Commit: The process where changes are applied to a repository.
Push: Commits are copied (pushed) TO the upstream branch.
Pull: Commits are copied (pulled) FROM the upstream branch and applied to files in the repository.
**Git:** Version-control software used frequently to track history & manage changes to files. Most commonly used in software development.
**Working Tree:** A tree-graph of changes made to tracked files.
**Tracked files:** any file that is being monitored by Git.
**Branch:** Collections of changes. Branches may have branches of their own, which can each contain differing versions of the same file.
**Merge:** The process of merging changes from one branch to another.
**Remote:** A repository other than the local that changes are synced to. A local repo may have multiple remotes.
**Upstream:** Typically refers to an item on the remote that the local copy is based on.
**Downstream:** Refers to items that are based on this. The production & development clones are all downstream from the Remote.
**Commit:** The process where changes are applied to a repository.
**Push:** Commits are copied (pushed) TO the upstream branch.
**Pull:** Commits are copied (pulled) FROM the upstream branch and applied to files in the repository.
### Install Git
[Download Git SCM for Windows](https://gitforwindows.org/)<br>
Run the installer. Default settings are acceptable.