Skip to content

Commit e9866ae

Browse files
committed
updated Readme
1 parent eed1625 commit e9866ae

File tree

3 files changed

+13
-19
lines changed

3 files changed

+13
-19
lines changed

Readme.md

+13-19
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
1-
# Typetron
2-
> **Note:** This project is a prototype in heavy development and not ready for production.
1+
# Twitter clone app made with Typetron
32

4-
**[Typetron](https://typetron.org)** is a **modern web framework** built for Node.js, written in **Typescript**, that
5-
allows you to build fully featured web applications.
6-
Typetron is best suited for small sized to enterprise level apps.
7-
Most of the core packages it uses were built from scratch in order to preserve the performance of the framework.
3+
![Home screen](public/screenshot1.png)
4+
![Profile page](public/screenshot1.png)
85

9-
_(check [this tutorial](https://typetron.org/tutorials/blog) on how to get started with Typetron)_
10-
11-
### Prerequisites
12-
- [NodeJs >=10 LTS](https://nodejs.org)
6+
This project was created as a result of going through
7+
the [Twitter clone app tutorial](https://typetron.org/tutorials/twitter-clone/) presented on
8+
the [Typetron](http://typetron.org/) website.
139

1410
## Getting started
11+
1512
```shell script
16-
git clone https://github.com/typetron/typetron my-awesome-project
17-
cd my-awesome-project
1813
npm install
1914
npm start
2015
```
21-
Check [http://localhost:8000](http://localhost:8000)
22-
23-
## Docs
24-
25-
Check the [official website](https://typetron.org/docs) for more details.
2616

17+
```shell script
18+
cd frontend
19+
npm install
20+
npm start
21+
```
2722

28-
## License
29-
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
23+
Open [http://localhost:4200](http://localhost:4200) to check the app.

public/screenshot1.png

352 KB
Loading

public/screenshot2.png

426 KB
Loading

0 commit comments

Comments
 (0)