Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation completed #27

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions Contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
### Important Guidelines 📝
- Go to [GitHub issues](https://github.com/poush/LatexGo/issues) page.
- Choose the issue you want to work on.
- Comment under that issue and let us know you're willing to work.
- Once the issue is assigned to you, start working on it.


### How to Contribute? 🤔💭

**1.** *Fork [this](https://github.com/poush/LatexGo) repository.*

**2.** *Clone the forked repository.*
``` terminal command
git clone https://github.com/<your github username>/LatexGo.git
```

**3.** *Navigate to the project directory.*
```terminal command
cd /LatexGo
```

**4.** *Create a new branch.*
```terminal command
git checkout -b <your_branch_name>
```

**5.** *Make changes in source code.*

**6.** *Commit your changes.*

```terminal
git add .
git commit -m "<your_commit_message>"
```

**7.** *Push your local branch to the remote repository.*
```terminal
git push -u origin <your_branch_name>
```

**8.** *Create a Pull Request!*

Wait for the mentors to review your pull request!

Keep Contributing!
Let's grow together! 👯‍♂️


51 changes: 51 additions & 0 deletions Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# SETTING UP THE PROJECT ON LOCAL WEB SEVER
___
## Have Python installed?
### If yes, follow the guidelines mentioned below for setting up the project using Python
The root folder of our project has `index.html` file.
- Open terminal/command prompt and navigate to cloned repository folder in your machine (i.e where `index.html` is present)

- Execute the following command for lower versions of Python i.e 2.x version:

python -m SimpleHttpServer 1337


- Execute the following command for Python version 3.x and above:

python3 -m http.server 1337



- Open http://localhost:1337/index.html in your browser.
- You should see something like

Serving HTTP on 0.0.0.0 port 1337(http://0.0.0.0:1337/) ...


## Have Python installed?
### If yes, follow the guidelines mentioned below for setting up the project using Npm
- Open terminal/command prompt and install `http-server` module globally on your machine.Execute:

npm install http-server -g

- Start a web server from a directory containing static website files.Change to the directory containing your static web files (e.g. html, javascript, css etc) in the command line window, e.g:

cd \Desktop\LatexGo

- Start the server with this command:

http-server

- You should see something like the following:

Starting up http-server, serving ./
Available on:
http://192.168.0.5:8080
http://127.0.0.1:8080
Hit CTRL-C to stop the server


### Refer to this [link](https://discussions.apple.com/docs/DOC-3083) for setting up project on Mac Os.



58 changes: 53 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,63 @@
# LatexGo
When Latex meets JS = SuperFast builds
# LatexGo 👩‍💻
*When Latex meets JS = SuperFast builds* 💪

## Description 📖
A project inspired by the aim of improving the writing experience and make it easy for people to use the power of Latex. It is based on a simple concept of client-side compiling thus uses emscripten to convert the LLVM based Latex compiler to Javascript compiler, making it easy to compile and accessible to everyone for free.

## Development
## Development 🏗️
1. Clone the repository.
2. Start a server inside the root directory (Look at [this](https://gist.github.com/jgravois/5e73b56fa7756fd00b89) if you need help with starting a server).
2. Start a server inside the root directory .Look at [Guide.md](Guide.md) if you need help with starting a server).
3. Open the browser and go to `http://localhost:{PORT}`.


### Ideas to work on
### Checkout the current development version 💁

[LatexGo Website](https://latexgo.ipiyush.com)

## Prerequisites to contribute 👇
It is desired to have a basic understanding of :
- LLVM compilers
- Emscripten
- Caching in browsers
- Typescript

Required:
- Understanding and some experience in Nodejs

And willingness to work!📙📕📗

## Enhance your skillset 💪
Through this project you will learn:

- WebSocket connections
- Syncing with Google Cloud
- About LLVM compilers
- Good Knowledge of Emscripten
- UI Designing skills

### Ideas to work on 🙆

1. Modularize the proof of concept
2. Improve lazy loading and caching
3. Implement Authorization, Live Collaboration, File Directry Management in the editor.

## Let's get started ! 👍🏻
We have made everything easy for you! 👐
Checkout [Contribute.md](contribute.md) to know how to contribute.



Have any query? Feel free to ask! 🙂

## License 📝
Refer to [LICENSE](https://github.com/poush/LatexGo/blob/master/LICENSE).

## Code of Conduct 📝
Refer to [CODE_OF_CONDUCT](https://github.com/poush/LatexGo/blob/add/activeUsers/CODE_OF_CONDUCT.md).

We are open to suggestions.If you've found a bug or want to suggest new features, you can create a [Github issue](https://github.com/poush/LatexGo/issues).

Let’s grow together!! 💛💙💛💙