profectus/profectus-docs
1
0
Fork 0
Code Issues12 Pull requests Projects1 Releases Packages Wiki Activity Actions

Add migration guide

Browse source
This commit is contained in:
thepaperpilot 2023-04-17 22:43:07 -05:00
parent b319e9940c
commit 4261cdface
5 changed files with 136 additions and 5 deletions
docs/guide/getting-started
setup.mdupdating.md

4
docs/guide/getting-started/setup.md
View file

@ -12,14 +12,14 @@ For local development, you will need the following tools:
Create a new project from the [Profectus repository](https://github.com/profectus-engine/Profectus) by clicking the "Use this template" button. Then, clone the repository locally using the provided link.
::: info
The template repository allows easy creation of multiple projects from one repository. However, updating an existing project to a newer version of Profectus can be challenging. Consider [updating Profectus](https://chat.openai.com/updating.md) _before_ starting development to avoid issues with unrelated histories.
The template repository allows easy creation of multiple projects from one repository. However, updating an existing project to a newer version of Profectus can be challenging. Consider [updating Profectus](./updating.md) _before_ starting development to avoid issues with unrelated histories.
:::
It's recommended to create a new Git branch for development, allowing you to push changes without affecting the live build. The GitHub workflow will automatically rebuild the page when you push to the `main` branch.
Next, install Profectus' dependencies by running `npm install`. Run `npm run serve` to start a local server hosting your project. The site will automatically reload as you modify files.
Also, follow the steps to [update Profectus](https://chat.openai.com/updating.md) before starting to make future updates easier without worrying about unrelated histories.
Also, follow the steps to [update Profectus](./updating.md) before starting to make future updates easier without worrying about unrelated histories.
### Deploying

6
docs/guide/getting-started/updating.md
View file

@ -2,7 +2,7 @@
## Github
Due to Profectus being a template repository, your projects do not share a git history with Profectus. In order to update changes, you will need to run the following:
Due to Profectus being a template repository, your projects do not share a git history with Profectus. To update changes, you will need to run the following:
```bash
git remote add template https://github.com/profectus-engine/Profectus
@ -14,8 +14,8 @@ The first command only has to be performed once. The third command may require y
## Replit
The sidebar has a tab labelled "Version Control", which you can use to merge all changes made to Profectus into your project. Unfortunately, replit does not have a merge tool so this process may irrecoverably erase changes you've made - I'd recommend making a backup first.
The sidebar has a tab labeled "Version Control", which you can use to merge all changes made to Profectus into your project. Unfortunately, Replit does not have a merge tool so this process may irrecoverably erase changes you've made - I'd recommend making a backup first.
## Glitch
Unfortunately glitch does not provide any method by which to update a project from a github repository. If you've only changed things in the data folder you may consider creating a new project, importing the current version of Profectus, and then placing your data folder in the new project.
Unfortunately, Glitch does not provide any method by which to update a project from a Github repository. If you've only changed things in the data folder you may consider creating a new project, importing the current version of Profectus, and then placing your data folder in the new project.