DibyashanuPati/cosmicflow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added preliminary instruction to access the repo

Browse source
This commit is contained in:
Dibyashanu Pati 2024-06-05 14:35:26 +05:30
parent 20ba1e69dd
commit be3306aac2
2 changed files with 97 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -1,3 +1,47 @@
# cosmicpirates.space
This is the source code of the cosmicpirates.space website
the cosmicpirates website
## Quickstart
Currently in the cosmicpirates.space source can ge accessed on our private [Gitea](https://about.gitea.com/) server.
### Step 1 : SSH into the cosmicpirates server with forward tunnel of port 3000 to your local port 3000
ssh into the server and forward the port on which Gitea is running(in our case port 3000) into our local port 3000
```console
ssh -L 3000:localhost:3000 pirate@cosmicpirates.space
```
### Step 2: Open Gitea on your Browser
Open http://localhost:3000/ in your browser
Create an account if nessasary(Not required if you just want to view but required if you want to push to a repo).
You should be able to see this project repository at http://localhost:3000/dibyashanu/cosmicpirates.space
### Step 3: Clone the repo
Make a local copy of this repo
```console
git clone http://localhost:3000/dibyashanu/cosmicpirates.space.git
```
Go to the repo directory
```console
cd cosmicpirates.space.
```
Set a username and email - this will be used to track the changes you make to this repository
```console
git config user.name "Your Name Here"
git config user.email "your@email.com"
```
Set the origin to the required location
```console
git remote add origin http://localhost:3000/dibyashanu/cosmicpirates.space.git
```
### Step 4: Make changes to the local version of the repository
Most of the time try only to make changes to the [main.org](./main.org) and generate all other content by either running scripts in this file or runing org-babel-tangle(C-c C-v t in doom emacs).
For more details see [main.org](./main.org)
### Step 5: Push Your changes to this repository
```console
$ git push -u origin main
```

54
main.org
View file

@ -21,6 +21,56 @@ Writing dynamic content to files and then using #+include to include them in oth
* Static content and Sample code snippets
** Generating the README.md file
#+begin_src md :tangle README.md
# cosmicpirates.space
This is the source code of the cosmicpirates.space website
## Quickstart
Currently in the cosmicpirates.space source can ge accessed on our private [Gitea](https://about.gitea.com/) server.
### Step 1 : SSH into the cosmicpirates server with forward tunnel of port 3000 to your local port 3000
ssh into the server and forward the port on which Gitea is running(in our case port 3000) into our local port 3000
```console
ssh -L 3000:localhost:3000 pirate@cosmicpirates.space
```
### Step 2: Open Gitea on your Browser
Open http://localhost:3000/ in your browser
Create an account if nessasary(Not required if you just want to view but required if you want to push to a repo).
You should be able to see this project repository at http://localhost:3000/dibyashanu/cosmicpirates.space
### Step 3: Clone the repo
Make a local copy of this repo
```console
git clone http://localhost:3000/dibyashanu/cosmicpirates.space.git
```
Go to the repo directory
```console
cd cosmicpirates.space.
```
Set a username and email - this will be used to track the changes you make to this repository
```console
git config user.name "Your Name Here"
git config user.email "your@email.com"
```
Set the origin to the required location
```console
git remote add origin http://localhost:3000/dibyashanu/cosmicpirates.space.git
```
### Step 4: Make changes to the local version of the repository
Most of the time try only to make changes to the [main.org](./main.org) and generate all other content by either running scripts in this file or runing org-babel-tangle(C-c C-v t in doom emacs).
For more details see [main.org](./main.org)
### Step 5: Push Your changes to this repository
```console
$ git push -u origin main
```
#+end_src
** Generating the ASCII headings
*** Main Heading
#+name: main-heading-text
@ -702,5 +752,5 @@ for root,dir,filename in os.walk(directory):
* TODO Things to do
** TODO Setup Gitea to host the source code (org files) of the website
* Things to do
** DONE Setup Gitea to host the source code (org files) of the website