Skip to content

Commit d2aeb1e

Browse files
improve readme
1 parent f8c1716 commit d2aeb1e

File tree

2 files changed

+55
-26
lines changed

2 files changed

+55
-26
lines changed

README.md

Lines changed: 55 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
# Fileonchain
22

3+
![Fileonchain Home Page](/priv/static/images/preview-home.png)
4+
35
Fileonchain is a secure file storage solution that allows anyone to upload small and large files to any substrate network, making them permanently available on-chain ⛓️.
46

5-
## Official Links
7+
## 🚀 Quick Links
68

7-
- Website: [https://fileonchain.org](https://fileonchain.org)
8-
- Twitter/X: [@fileonchain](https://twitter.com/fileonchain)
9+
- 🌐 Website: [https://fileonchain.org](https://fileonchain.org)
10+
- 🐦 Twitter: [@fileonchain](https://twitter.com/fileonchain)
11+
- 🖥️ Live Demo: [https://staging.fileonchain.org/](https://staging.fileonchain.org/)
912

10-
## Getting Started
13+
## 🛠️ Getting Started
1114

1215
### Using Docker Compose
1316

14-
1. Ensure you have Docker and Docker Compose installed on your system.
15-
17+
1. Ensure Docker and Docker Compose are installed on your system.
1618
2. Clone the repository and navigate to the project directory.
19+
3. Create a `.env` file in the root directory with the following:
1720

18-
3. Create a `.env` file in the root directory with the following environment variables:
1921
```
2022
DB_PASSWORD=your_db_password
2123
DB_PORT=5432
@@ -26,37 +28,64 @@ Fileonchain is a secure file storage solution that allows anyone to upload small
2628
PHX_HOST=localhost
2729
```
2830

29-
4. Run the following command to start all services:
31+
4. Start all services:
3032
```
3133
docker compose up
3234
```
3335

34-
5. Once all containers are up and running, you can access:
35-
- The Phoenix application at [`http://localhost:4000`](http://localhost:4000)
36-
- The Hasura GraphQL engine at [`http://localhost:8080`](http://localhost:8080)
36+
5. Start Phoenix, in a new terminal:
37+
```
38+
mix phx.server
39+
```
40+
41+
5. Access the services:
42+
- Phoenix application: [http://localhost:4000](http://localhost:4000)
43+
- Hasura GraphQL engine: [http://localhost:8080](http://localhost:8080)
44+
45+
### Normal Setup for Phoenix @Web
46+
47+
1. Install dependencies:
48+
```
49+
mix deps.get
50+
```
51+
52+
2. Create and migrate your database:
53+
```
54+
mix setup
55+
mix ecto.migrate
56+
```
57+
58+
3. Start Phoenix server:
59+
```
60+
mix phx.server
61+
```
62+
63+
4. Access the application at [http://localhost:4000](http://localhost:4000)
3764

3865
### Manual Setup (for development)
3966

40-
If you prefer to run the services separately:
67+
1. Start Postgres and Hasura: `docker compose up db graphql-engine`
68+
2. Install dependencies: `mix setup`
69+
3. Start Phoenix endpoint: `mix phx.server` or `iex -S mix phx.server` (inside IEx)
70+
71+
Visit [localhost:4000](http://localhost:4000) in your browser.
4172

42-
1. Run `docker compose up db graphql-engine` to start Postgres and Hasura.
43-
2. Run `mix setup` to install and setup dependencies.
44-
3. Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`.
73+
## 📚 Learn More
4574

46-
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
75+
- [Phoenix Framework](https://www.phoenixframework.org/)
76+
- [Phoenix Guides](https://hexdocs.pm/phoenix/overview.html)
77+
- [Phoenix Documentation](https://hexdocs.pm/phoenix)
78+
- [Elixir Forum](https://elixirforum.com/c/phoenix-forum)
79+
- [Phoenix GitHub Repository](https://github.com/phoenixframework/phoenix)
4780

48-
## Live Demo
81+
## 🚀 Deployment
4982

50-
You can try out the live demo of Fileonchain at [https://staging.fileonchain.org/](https://staging.fileonchain.org/).
83+
Ready for production? Check out the [Phoenix deployment guides](https://hexdocs.pm/phoenix/deployment.html).
5184

52-
## Learn more
85+
## 🤝 Contributing
5386

54-
* Official website: https://www.phoenixframework.org/
55-
* Guides: https://hexdocs.pm/phoenix/overview.html
56-
* Docs: https://hexdocs.pm/phoenix
57-
* Forum: https://elixirforum.com/c/phoenix-forum
58-
* Source: https://github.com/phoenixframework/phoenix
87+
We welcome contributions! Please feel free to submit a Pull Request.
5988

60-
## Deployment
89+
## 📄 License
6190

62-
Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html).
91+
This project is licensed under the [MIT License](LICENSE.md).

priv/static/images/preview-home.png

1.44 MB
Loading

0 commit comments

Comments
 (0)