mirror of
https://github.com/neocities/neocities.git
synced 2025-04-24 17:22:35 +02:00
35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
### NOTE: THIS IS NOT FOR NEOCITIES SUPPORT! Any issues filed not related to the source code itself will be closed. For support please contact: https://neocities.org/contact
|
|
|
|
# Neocities.org
|
|
|
|
[](https://travis-ci.org/neocities/neocities)
|
|
[](https://coveralls.io/github/neocities/neocities?branch=master)
|
|
|
|
The web site for Neocities! It's open source. Want a feature on the site? Send a pull request!
|
|
|
|
## Getting Started
|
|
|
|
Neocities can be quickly launched in development mode with [Vagrant](https://www.vagrantup.com). Vagrant builds a virtual machine that automatically installs everything you need to run Neocities as a developer. Install Vagrant, then from the command line:
|
|
|
|
```
|
|
vagrant up --provision
|
|
```
|
|
|
|
|
|
|
|
```
|
|
vagrant ssh
|
|
bundle exec rackup -o 0.0.0.0
|
|
```
|
|
|
|
Now you can access the running site from your browser: http://127.0.0.1:9292
|
|
|
|
## Want to contribute?
|
|
|
|
If you'd like to fix a bug, or make an improvement, or add a new feature, it's easy! Just send us a Pull Request.
|
|
|
|
1. Fork it (<http://github.com/YOURUSERNAME/neocities/fork>)
|
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
4. Push to the branch (`git push origin my-new-feature`)
|
|
5. Create new Pull Request
|