Restoring the README.md for cvbuilder_0
This commit is contained in:
David Livingstone committed
1 parent
40314dfd20
commit
870d41cdaf
1 file changed
+12
-82
@@ -1,93 +1,23 @@
|
|||||||
# cvbuilder_0
|
# cvbuilder_0
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
This is the starting point for your cvbuilder coursework. The last number in the repo name should match the last number in your student id (Knumber).
|
||||||
|
|
||||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
# TB2 Software Development Coursework - CVBuilder App
|
||||||
|
|
||||||
## Add your files
|
As part of Unit 2 - Software Application Development you have a [Software Development Coursework Assignment](https://canvas.kingston.ac.uk/courses/26279/assignments/133246) that is worth 30% of your total module mark. There is a [Coursework Assignment Brief](./docs/CourseworkAssignmentBrief.md) which details the Requirements and Assessment Criteria. It is important that you only do the Requirements (CV Sections) that are assigned to you according to the last number in your student id (Knumber). You are provided with some typical [data](./data/cv_repo_0.csv) to get you started with your application. The cvbuilder follows on from the Swing Portfolio Coursework that you did - in particular for the compulsory User Section of the CV. This was all discussed in the [CI5105 TB2 Week 7 - Coursework Lecture Video](https://kingstonuniversity.sharepoint.com/:v:/r/sites/Course_ci5105_all_ty13_23-fmUrIjN9H4HBt/Shared%20Documents/General/Recordings/CI5105TB2Week7Lecture-CWK-20240222_111951-Meeting%20Recording.mp4?csf=1&web=1&e=QpdUcA&nav=eyJyZWZlcnJhbEluZm8iOnsicmVmZXJyYWxBcHAiOiJTdHJlYW1XZWJBcHAiLCJyZWZlcnJhbFZpZXciOiJTaGFyZURpYWxvZy1MaW5rIiwicmVmZXJyYWxBcHBQbGF0Zm9ybSI6IldlYiIsInJlZmVycmFsTW9kZSI6InZpZXcifX0%3D)
|
||||||
|
|
||||||
|
|
||||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
You should follow a development process similar to the specified for your UserProfileBuilder i.e. you must develop your code in this repository with the correct use of KUGitlab with frequent commits and appropriate commit messages as you progress.
|
||||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
|
||||||
|
|
||||||
```
|
# CV Builder App Start Code
|
||||||
cd existing_repo
|
|
||||||
git remote add origin https://gitlab.com/KUGitlab/ci5105/development/assessment/cvbuilder_0.git
|
|
||||||
git branch -M main
|
|
||||||
git push -uf origin main
|
|
||||||
```
|
|
||||||
|
|
||||||
## Integrate with your tools
|
You have been provided with a basic Maven Project that includes a single package (cvbuilder) with a .gitkeep file in it. This should be the top-level package for your code and you should create other packages beneath this. You should clone this project as covered in (Using KUGitlab - Access and Workflow)[https://kingstonuniversity.sharepoint.com/:p:/s/CI5105Privatemst/EXORk0ko9Y5EiZaPDW8x0vcBQ4ltw2hfrlRG3kj9UimQSg?e=6lyeEW]
|
||||||
|
|
||||||
- [ ] [Set up project integrations](https://gitlab.com/KUGitlab/ci5105/development/assessment/cvbuilder_0/-/settings/integrations)
|
To get this sample code onto your local machine you will need to:
|
||||||
|
|
||||||
## Collaborate with your team
|
- [ ] [Create a project access token ](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#personal-access-tokens). This will be used to allow you to authenticate to GitLab.com/KUGitlab for the purposes of typical operations e.g. cloning and pushing to private repositories in your sub-group. You will typically only need on e personal access token but you can create a new one whenever you require it and delete old ones.
|
||||||
|
-[] Optionally Import the Project into your Portfolio Namespace - for 'Self-imported Repository' if it hasn't been 'Pre-imported'. Check if the Repository is already in your Namespace
|
||||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
- [ ] [Clone this new Repository using your Personal Access Token](https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html#clone-using-a-token). You can do this from an IDE (e.g. NetBeans) or from the command-line (e.g. Git Bash)
|
||||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
- [ ] Use a Git development process (add, commit, push) to version manage your code. This will be covered in the module but is [typically](https://docs.gitlab.com/ee/gitlab-basics/add-file.html). Currently your Portfolio Sub-Group has not been set-up and so you will not be able to push back your changes. You don't have the permission to do this to the origin repository - or else these changes would change the sample code for everyone else!
|
||||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
|
||||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
||||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
|
||||||
|
|
||||||
## Test and Deploy
|
|
||||||
|
|
||||||
Use the built-in continuous integration in GitLab.
|
|
||||||
|
|
||||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
|
||||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
||||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
||||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
||||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
# Editing this README
|
|
||||||
|
|
||||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
||||||
|
|
||||||
## Suggestions for a good README
|
|
||||||
|
|
||||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
||||||
|
|
||||||
## Name
|
|
||||||
Choose a self-explaining name for your project.
|
|
||||||
|
|
||||||
## Description
|
|
||||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
||||||
|
|
||||||
## Badges
|
|
||||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
||||||
|
|
||||||
## Visuals
|
|
||||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
||||||
|
|
||||||
## Support
|
|
||||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
State if you are open to contributions and what your requirements are for accepting them.
|
|
||||||
|
|
||||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
||||||
|
|
||||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
||||||
|
|
||||||
## Authors and acknowledgment
|
|
||||||
Show your appreciation to those who have contributed to the project.
|
|
||||||
|
|
||||||
## License
|
|
||||||
For open source projects, say how it is licensed.
|
|
||||||
|
|
||||||
## Project status
|
|
||||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
||||||
Reference in new issue
Block a user