Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Initial commit.
  • Loading branch information
ElectricMan committed Nov 4, 2012
1 parent 9f8c810 commit 498b197
Show file tree
Hide file tree
Showing 122 changed files with 12,127 additions and 4 deletions.
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
############
## Windows
############

# Windows image file caches
Thumbs.db

# Folder config file
Desktop.ini

# MySQL Config files
include/mysql_connect.php
include/login/config.php
4 changes: 4 additions & 0 deletions .htaccess
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Default .htaccess file
RewriteEngine On
RewriteCond %{HTTP_HOST} !^www\.ecdb\.net
RewriteRule (.*) http://www.ecdb.net/$1 [R=301,L]
65 changes: 65 additions & 0 deletions LICENSE.md

Large diffs are not rendered by default.

137 changes: 133 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,133 @@
ecDB
====

ecDB.net, Electronics Component DataBase
README
====

## What is ecDB

[ecDB.net](http://www.ecdb.net) is basically a place where you, as an electronics hobbyist (or professional) can add your own components
to your personal database to keep track of what components you own, where they are, how many you own and so on.

## Who and Why

ecDB is created by [Nils Fredriksson](http://nilsf.se) aka. ElectricMan, and designed by [Buildlog](http://buildlog.se).

The reason I publish the code for [ecDB.net](http://www.ecdb.net) is that I simply don't have enough time,
and my knowledge is not sufficient to develop [ecDB.net](http://www.ecdb.net) to the point I wish. Therefore
I need help from the community to make [ecDB.net](http://www.ecdb.net) better!

## Contact and Discussion

* Twitter: [@ecDBnet](http://twitter.com/ecDBnet)
* Website: [www.ecDB.net](http://www.ecdb.net)
* IRC: [irc.freenode.net, #ecDB ](http://webchat.freenode.net?channels=ecdb)
* Github: [https://github.com/ElectricMan/ecDB](https://github.com/ElectricMan/ecDB)
* E-mail: [info@ecdb.net](mailto:info@ecdb.net)

## Release Information

This repo contains in development code for future releases. To download the
latest stable release please visit the [download page](https://github.com/ElectricMan/ecDB/downloads).

## Changelog and New Features

You can find a list of all changes for each release in the [wiki](https://github.com/ElectricMan/Test/wiki/Changelog).

## Documentation

Currently there is no documentation available. Please feel free to create it!

## Installation

- Create a MySQL database.
- Import `ecdb_databse.sql` database structure to your MySQL-database.
- Place the ecDB files in your web server's root directory. (Known issue and need to be fixed asap.).
- Insert your MySQL data in the two configuration files, `include/mysql_connect.php` and `include/login/config.php`.
- **You are now set to go!** The default username is `demo` and password `demo`.

### Requirements

- Web Server.
- PHP Version 5.2.4 or above.
- MySQL Version 5.0 or above.

## Contributing

ecDB is a community driven project and accepts contributions of code
and documentation from the community. These contributions are made in the form
of Issues or [Pull Requests](http://help.github.com/send-pull-requests/) on
the [ElectricMan ecDB repository](https://github.com/ElectricMan/ecDB) on GitHub.

Issues are a quick way to point out a bug. If you find a bug or documentation
error in ecDB then please check a few things first:

- There is not already an open Issue
- The issue has already been fixed (check the develop branch, or look for
closed Issues)
- Is it something really obvious that you fix it yourself?

Reporting issues is helpful but an even better approach is to send a Pull
Request, which is done by "Forking" the main repository and committing to your
own copy. This will require you to use the version control system called Git.

## Branching

ecDB uses two brances, "master" and "develop".
This requires all pull requests to be sent to the "develop" branch. This is
where the next planned version will be developed. The "master" branch will
always contain the latest stable version and is kept clean so a "hotfix" (e.g:
an emergency security patch) can be applied to master to create a new version,
without worrying about other features holding it up. For this reason all
commits need to be made to "develop" and any sent to "master" will be closed
automatically. If you have multiple changes to submit, please place all
changes into their own branch on your fork.

One thing at a time: A pull request should only contain one change. That does
not mean only one commit, but one change - however many commits it took. The
reason for this is that if you change X and Y but send a pull request for both
at the same time, we might really want X but disagree with Y, meaning we
cannot merge the request. Using the Git-Flow branching model you can create
new branches for both of these features and send two requests.

## How-to Guide

There are two ways to make changes, the easy way and the hard way. Either way
you will need to [create a GitHub account](https://github.com/signup/free).

Easy way GitHub allows in-line editing of files for making simple typo changes
and quick-fixes. This is not the best way as you are unable to test the code
works. If you do this you could be introducing syntax errors, etc, but for a
Git-phobic user this is good for a quick-fix.

Hard way The best way to contribute is to "clone" your fork of ecDB to
your development area. That sounds like some jargon, but "forking" on GitHub
means "making a copy of that repo to your account" and "cloning" means
"copying that code to your environment so you can work on it".

- Set up Git (Windows, Mac & Linux)
- Go to the ecDB repo
- Fork it
- Clone your ecDB repo: git@github.com:<your-name>/ecDB.git
- Checkout the "develop" branch At this point you are ready to start making
changes.
- Fix existing bugs on the Issue tracker after taking a look to see nobody
else is working on them.
- Commit the files
- Push your develop branch to your fork
- Send a pull request http://help.github.com/send-pull-requests/

The Reactor Engineers will now be alerted about the change and at least one of
the team will respond. If your change fails to meet the guidelines it will be
bounced, or feedback will be provided to help you improve it.

Once the Reactor Engineer handling your pull request is happy with it they
will post it to the internal ecDB discussion area to be double checked by
the other Engineers and ecDB developers. If nobody has a problem with the
change then it will be merged into develop and will be part of the next
release.

## License

- ecDB is licensed under a Creative Commons [Attribution-NonCommercial-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/).
- The ecDB code is not allowed for public use, other than on [www.ecDB.net](http://www.ecdb.net).
- You are allowed to set up a private ecDB database for yourself, or whithin an organisation.

###### Parts of this readme originates from [CodeIgniter](https://github.com/EllisLab/CodeIgniter)
94 changes: 94 additions & 0 deletions about.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<?php
require_once('include/debug.php');
?>
<!DOCTYPE HTML>
<html>
<head>
<link rel="stylesheet" type="text/css" href="include/style.css" media="screen"/>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="shortcut icon" href="favicon.ico" />
<link rel="apple-touch-icon" href="img/apple.png" />
<title>About - ecDB</title>
<?php include_once("include/analytics.php") ?>

</head>
<body>
<div id="wrapper">

<!-- Header -->
<div id="header">
<div class="logoWrapper">
<a href ="."><span class="logoImage"></span></a>
</div>
</div>
<!-- END -->

<!-- Main menu -->
<div id="menu">
<ul>
<li><a href=".">Login</a></li>
<li><a href="register.php">Register</a></li>
<li><a href="about.php" class="selected">About</a></li>
<li><a href="/blog">Blog</a></li>
</ul>
</div>
<!-- END -->

<!-- Main content -->
<div id="content">
<div class="loginWrapper">
<div class="left">
<div class="message orange">
Check out the new <a href="/blog">ecDB blog.</a> Or follow <a href="https://twitter.com/#!/ecDBnet">@ecDBnet</a> at Twitter to get the latest updates!
</div>
<h1>What is ecDB?</h1>

ecDB is basically a place where you, as an electronics hobbyist (or professional) can add your own components to your personal database to keep track of what components you own, where they are, how many you own and so on.

<br /><br />
<a href="img/about/index.png"><img src="img/about/index_thumbnail.png"></a>
<a href="img/about/add.png"><img src="img/about/add_thumbnail.png"></a><br /><br />
<h1>Who & Why?</h1>

ecDB is created by <a target="_blank" href="http://nilsf.se">Nils Fredriksson</a> and designed by <a target="_blank" href="http://www.buildlog.eu">Buildlog</a>. <br /><br />

Me, Nils, have always wanted to have a system like this to keep track of what component I own. Before I created this system I (I guess you too...) had to dig through boxes filled with components to maybe find that component I needed. This is an unnecessary task to do, it not only takes time, and it also can be really frustrating not to find that component you are looking for. So I ended up creating this website where I easily can keep track of my components!

<br /><br />
<h1>What does it cost?</h1>

ecDB is completely free!<br />
But if you like ecDB you can use this button to donate us some money.
<form action="https://www.paypal.com/cgi-bin/webscr" method="post">
<input type="hidden" name="cmd" value="_s-xclick">
<input type="hidden" name="hosted_button_id" value="7ZT5UY5XMHA52">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
</form>

<br />
<h1>Is ecDB really done?</h1>
No! ecDB is still under development. Here are some of the upcoming features:<br /><br />

- Public components - a place where you easily can trade components.<br />
- View to physically print the personal database. Old-school typewritten text and nice colums!<br />
- Datasheet and picture uploading.<br />
- Advanced component search with parameters.<br />
- Log for each component. See when the component last was used/edited/bought etc.<br />
- Barcode implementation for easy storage management.<br />
- Import and export of personal database to text/spreadsheet.<br />
- Quick edit function of component data directly from the database view.<br />
- Add personal categories and fields.<br />
- Borrow component data from other components in the database to easily add components.
</div>
<div class="right"></div>
</div>
</div>
<!-- END -->

<!-- Text outside the main content -->
<?php include 'include/footer.php'; ?>
<!-- END -->

</div>
</body>
</html>
Loading

0 comments on commit 498b197

Please sign in to comment.